Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Mandates

Lists direct debit mandates for a bank account.

get/v0/bank/accounts/{bank-account-id}/mandates

Path parameters

bank-account-idstring required

Query parameters

sort'-created-at' | 'created-at'
page[size]integer
page[after]string byte

A base64 encoded opaque string returned in paginated responses.

page[before]string byte

A base64 encoded opaque string returned in paginated responses.

Response

OK

Example response

{
  "mandates": [
    {
      "collection-amount": {
        "max-amount": {
          "currency": "GBP",
          "value": "1000.00"
        }
      },
      "creditor": {
        "iban": "GB42GFNB12345612345678",
        "uk-domestic-sort-code": "123456",
        "bic": "GFNBGB22",
        "account-number": "12345678",
        "bank-id": "123456",
        "bban": "GFNB12345612345678",
        "uk-domestic-account-number": "12345678",
        "other-account-identification": "ABC123",
        "other-institution-identification": "ABC123"
      }
    }
  ]
}