Get a list of mandates

get/mandates

API Version

Returns a list of all direct debit mandates created for a business account.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v2/mandates

Query Parameters

Required

Optional

The pagination cursor returned in a previous GET /mandates request.

The unique identifier of the payment instrument linked to the mandate.

The unique identifier of the balance account linked to the payment instrument.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded
linkobject
Contains links to the next and previous page whenever applicable.
firstobject
The link to the first page of the list.
hrefstring
lastobject
The link to the last page of the list.
hrefstring
nextobject
The link to the next page of the list.
hrefstring
previousobject
The link to the previous page of the list.
hrefstring
selfobject
The link to the list page you are currently viewing.
hrefstring
mandatesarray[object]
Contains a list of the mandates.
balanceAccountIdstring
The unique identifier of the balance account linked to the payment instrument.
counterpartyobject
Contains information to identify the counterparty.
accountHolderobject
Contains information about the owner of the counterparty bank account.
fullNamestring
The full name of the entity that owns the bank account.

Supported characters: [a-z] [A-Z] [0-9] , . ; : - — / \ + & ! ? @ ( ) " ' and space.
accountIdentificationobject
Contains the bank account details of the counterparty. The fields required in this object depend on the country of the bank account and the currency of the transfer.
typestring
createdAtstring
The date when the mandate was created.
idstring
The unique identifier of the mandate.
paymentInstrumentIdstring
The unique identifier of the payment instrument linked to the mandate.
statusstring
The status of the mandate.

Possible values: pending, approved, cancelled.
typestring
The type of mandate. Possible value: bacs.
updatedAtstring
The date when the mandate was updated.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
500 - Internal Server Error
The server could not process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Get a list of mandates

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error