List Payment Instrument Mandates

Preview: This endpoint is a preview API and may change without a deprecation period.

Lists the payment instrument mandates of the customer account, newest first. canceled and rejected mandates remain listed as history. Filters can be combined.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

An account identifier.

Query Params
PaymentInstrumentMandateStatus | string

Only return mandates whose current status is the given one. Set to * to return mandates of every status, the same as omitting this parameter.

string
enum

Only return mandates of the given payment method.

Allowed:
string
length ≤ 35

Only return the mandate with the given mandate reference. The comparison ignores case.

string

A pagination cursor. When you receive a paginated response containing the property pagination.next_cursor, you can pass its value here to get the next page of results for your query.
A cursor will include filter parameters, so there is not need to specify both the cursor and any other filter parameter.

integer
1 to 100
Defaults to 100

In order to customize the number of elements returned, you can provide a limit here. The service will not return more elements than specified.

Headers
string
required
string
required
Responses

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