v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Mandates

List mandates

Returns a list of mandates. For further details on Pagination, see general section above.

get/payments/v2/mandates

Query parameters

externalAccountIdstring

Include only mandates associated with the given external account.

counterpartyIdstring

Include only mandates associated with the given counterparty.

Example:SENT

Include only mandates with the given status.

Direct debit payment scheme. Choose among: <ul>

<li><code>SDD_CORE</code> (<a href="https://www.europeanpaymentscouncil.eu/what-we-do/epc-payment-schemes/sepa-direct-debit/sepa-direct-debit-core-rulebook-and-implementation">SEPA Direct Debit Core</a>)</li> <li><code>SDD_B2B</code> (<a href="https://www.europeanpaymentscouncil.eu/what-we-do/epc-payment-schemes/sepa-direct-debit/sepa-direct-debit-b2b-rulebook-and-implementation">SEPA Direct Debit B2B</a>)</li> <li><code>GB_DD_BACS</code> (UK <a href="https://www.bacs.co.uk">BACS</a> Direct Debit)</li> <li><code>AUTOGIRO</code> (Swedish <a href="https://www.bankgirot.se/autogiro">Bg AutoGiro</a>)</li> <li><code>CH_DD_LSV</code> (Swiss <a href="https://www.six-group.com/en/products-services/banking-services/billing-and-payments/direct-debits.html">Direct Debit LSV+</a>)</li> <li><code>CH_DD_BDD</code> (Swiss <a href="https://www.six-group.com/en/products-services/banking-services/billing-and-payments/direct-debits.html">Direct Debit BDD</a>)</li> </ul>

Example:SDD_CORE

Include only mandates with the payment scheme.

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

List of mandates.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "counterpartyId": "f3efbb73-4e5b-4b22-adeb-918bbf1dfbd8",
      "externalAccountId": "ba0ad236-2904-4b01-8e85-a4ef3a73c353",
      "destinationAccountId": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
      "connectionInstructionId": "c1d6502c-07c7-4c77-bee5-963f9464c7d8",
      "source": {
        "id": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
        "organizationId": "605e26fc-4fce-495a-a92f-2c3592d7287e",
        "market": "GB",
        "type": "EXTERNAL_ACCOUNT",
        "identifiers": [
          {
            "type": "IBAN",
            "market": "GB",
            "number": "GB33BUKB20201555555555"
          }
        ],
        "routing": [
          {
            "type": "BIC",
            "number": "BUKBGB22XXX"
          }
        ]
      },
      "sourceHolder": {
        "type": "ENTITY",
        "id": "29a4555b-99b2-4de7-9062-47c8ebc03f56",
        "legalName": "Example Company GmbH",
        "address": {
          "country": "DE",
          "city": "Munich",
          "postalCode": "123456"
        }
      },
      "scheme": "SDD_CORE",
      "signatureDate": "2022-05-07",
      "status": "SENT",
      "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      },
      "version": 1,
      "etag": "version:3",
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}