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

[
  {
    "CreationDate": 1663244376,
    "ExecutionType": "WEB",
    "Id": "mdt_m_01J98YZT8AJBGWX47AA077XMKZ",
    "MandateType": "DIRECT_DEBIT",
    "ResultCode": 1807,
    "ResultMessage": "User has let the mandate session expire without confirming",
    "Status": "FAILED",
    "Tag": "Created using the Mangopay API Postman collection",
    "UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T"
  },
  {
    "CreationDate": 1669040333,
    "ExecutionType": "WEB",
    "Id": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
    "MandateType": "DIRECT_DEBIT",
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "Status": "ACTIVE",
    "Tag": "Created using the Mangopay API Postman collection",
    "UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T"
  }
]

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.

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 Recipient (or legacy Bank Account object). This property is being replaced by RecipientId, which you should rely on instead.

Response

Success

Array (Mandates)list of objectsOptional

The list of mandates created by the platform.