API Reference

List mandates

get
https://api.atlar.com/payments/v2/mandates

Returns a list of mandates. For further details on Pagination, see general section above.

Query Params
string

Include only mandates associated with the given external account.

string

Include only mandates associated with the given counterparty.

string
enum

Include only mandates with the given status.

string
enum

Include only mandates with the payment scheme.

Allowed:
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