API Reference
  1. Payment Defaults API
  2. Payment Defaults

Get a List of Payment Defaults

get
https://{BASE_URL}/v1/payment-defaults

Retrieves a paginated list of payment defaults. All query parameters are optional.

A payment default with ENDED status always has a currentDebtSum of 0.00.

For payment defaults with DELETED status, only paymentDefaultId, defaultStatus, and defaultDeletionDate are returned — currentDebtSum is not included.


Query Params
integer
≥ 1
Defaults to 1

Page number to retrieve. Defaults to 1.

integer
1 to 250
Defaults to 250

Number of records per page. Defaults to 250. Maximum allowed value is 250.

statuses[]
array of strings

Filter by payment default status. Multiple values can be provided. Possible values: PENDING, ACTIVE, ENDED, DISPUTED, DELETED. Example: ?statuses[]=ACTIVE&statuses[]=ENDED

statuses[]
Allowed:
string

Filter by the debtor's personal identification code or registration code.

Response

Updated 10 days ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago

Did this page help you?