API Reference

List direct debits

get
https://api.atlar.com/payments/v2/direct-debits

Returns a list of direct debits. For further details on Pagination, see general section above. Sort order is always descending on date.

Query Params
string

Include only direct debits for the given destination account.

string
enum

Include only direct debits with the given status.

Include only direct debits with property date matching the given value. The parameter value may be either a string for equality matching, or an object for range-like matching criteria.

string
enum

Include only direct debits with the given direct debit scheme.

Allowed:
string

Include only direct debits that are part of the payment batch with the given batch ID.

integer
1 to 500
Defaults to 100

Limit the number of items in resulting query response.

string

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Responses

Updated 4 days ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago