List Mandates for a Bank Account

GET

/v2.01/:ClientId/users/:UserId/bankaccounts/:BankAccountId/mandates

GET

/v2.01/:ClientId/users/:UserId/bankaccounts/:BankAccountId/mandates

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/users/{UserId}/bankaccounts/{BankAccountId}/mandates \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 [
2   {
3     "CreationDate": 1663244376,
4     "ExecutionType": "WEB",
5     "Id": "mdt_m_01J98YZT8AJBGWX47AA077XMKZ",
6     "MandateType": "DIRECT_DEBIT",
7     "ResultCode": 1807,
8     "ResultMessage": "User has let the mandate session expire without confirming",
9     "Status": "FAILED",
10     "Tag": "Created using the Mangopay API Postman collection",
11     "UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T"
12   },
13   {
14     "CreationDate": 1669040333,
15     "ExecutionType": "WEB",
16     "Id": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
17     "MandateType": "DIRECT_DEBIT",
18     "ResultCode": "000000",
19     "ResultMessage": "Success",
20     "Status": "ACTIVE",
21     "Tag": "Created using the Mangopay API Postman collection",
22     "UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T"
23   }
24 ]

List Mandates for a Bank Account

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

UserIdstringRequired

The unique identifier of the user.

BankAccountIdstringRequired

The unique identifier of the bank account.

Warning: The corresponding Bank Account must belong to the BACS network (GB-type Bank Account) or SEPA network (IBAN-type Bank Account).

Response

Success

Array (Mandates)list of objects

The list of mandates created by the platform.