Payments

Mandates

Download Spec

All direct debit mandates related paths

get/users/{user_id}/payments/mandates

List mandates

sortstring

Field of resource to sort by

Default: "created_at"
Enum: id
created_at
Example: "id"

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

Responses

Response examples

Mandates list

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "9c5a7dea-46f2-4502-b6b5-9902a53860e4",
      "created_at": "2020-08-24T14:15:22Z",
      "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
      "iban": "DE8900**********0000",
      "bic": "ABCDEXXX",
      "creditor_name": "Creditor Company",
      "creditor_id": "DE98ZZZ09999999999",
      "creditor_address": {
        "address_line1": "Strasse 1",
        "address_line2": "Company GmbH",
        "postcode": "12345",
        "city": "Berlin",
        "state": "BE",
        "country": "DE"
      },
      "type": "RECURRENT",
      "confirmed_at": "2021-12-08T08:38:48.021Z"
    }
  ]
}

post/payments/mandates

Create a mandate

user_idstring

User unique identifier.

Format: uuid

ibanstring

required

International Bank Account Number IBAN.

Pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$

bicstring

required

Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) ISO 9362.

Pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$

confirmed_atstring

required

Timestamp of when user validated the mandate

Format: date-time

Responses

Request examples

{
  "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "iban": "DE89000000000000000000",
  "bic": "ABCDEXXX",
  "confirmed_at": "2021-12-08T08:38:48.021Z"
}

Response examples

Mandate

{
  "id": "9c5a7dea-46f2-4502-b6b5-9902a53860e4",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "iban": "DE8900**********0000",
  "bic": "ABCDEXXX",
  "creditor_name": "Creditor Company",
  "creditor_id": "DE98ZZZ09999999999",
  "creditor_address": {
    "address_line1": "Strasse 1",
    "address_line2": "Company GmbH",
    "postcode": "12345",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "type": "RECURRENT",
  "confirmed_at": "2021-12-08T08:38:48.021Z"
}

get/payments/mandates/{mandate_id}

Retrieve a direct debit mandate

mandate_idstring

required

Direct Debit Mandate unique identifier.

Format: uuid

Responses

Response examples

Mandate

{
  "id": "9c5a7dea-46f2-4502-b6b5-9902a53860e4",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "iban": "DE8900**********0000",
  "bic": "ABCDEXXX",
  "creditor_name": "Creditor Company",
  "creditor_id": "DE98ZZZ09999999999",
  "creditor_address": {
    "address_line1": "Strasse 1",
    "address_line2": "Company GmbH",
    "postcode": "12345",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "type": "RECURRENT",
  "confirmed_at": "2021-12-08T08:38:48.021Z"
}

delete/payments/mandates/{mandate_id}

Delete mandate

mandate_idstring

required

Direct Debit Mandate unique identifier.

Format: uuid

Responses

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?