Payments

Direct Debits

Download Spec

All direct debits related paths

get/account_groups/{account_group_id}/payments/direct_debits

List direct debits

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

Direct debits list

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
      "created_at": "2020-08-24T14:15:22Z",
      "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
      "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
      "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
      "cash_amount": "200.00",
      "currency": "EUR",
      "remittance_information": "payment for green energy portfolio",
      "status": "NEW",
      "purpose_code": "OTHR"
    }
  ]
}

post/payments/direct_debits

Trigger a direct debit

user_idstring

required

User unique identifier.

Format: uuid

account_group_idstring

required

Account group unique identifier.

Format: uuid

mandate_idstring

required

Direct Debit Mandate unique identifier.

Format: uuid

cash_amountstring

required

Pattern: ^-?[0-9]{1,9}(\.[0-9]{2})?$

currencystring

Alphabetic three-letter ISO 4217 currency code.

EUR - Euro
GBP - Pound Sterling

Enum: EUR
GBP

remittance_informationstring

Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting (see more).

Pattern: ^[0-9A-Za-z+?/\-:()\.,';_ ]{0,140}$
Max Length: 140

purpose_codestring

Purpose of the payment based on ExternalPurpose1Code from ISO 20022.

Max Length: 4

Responses

Request examples

{
  "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "mandate_id": "95b8304e-19fc-4cd9-8e50-82532e6b8d8c",
  "cash_amount": "200.00",
  "currency": "EUR",
  "remittance_information": "payment for green energy portfolio",
  "purpose_code": "OTHR"
}

Response examples

Direct debit

{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
  "cash_amount": "200.00",
  "currency": "EUR",
  "status": "NEW",
  "purpose_code": "OTHR"
}

get/payments/direct_debits/{direct_debit_id}

Retrieve a direct debit

direct_debit_idstring

required

Direct debit funding request unique identifier

Format: uuid

Responses

Response examples

Direct debit payment

{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
  "cash_amount": "200.00",
  "currency": "EUR",
  "remittance_information": "payment for green energy portfolio",
  "status": "NEW",
  "purpose_code": "OTHR"
}

webhook

Direct Debit events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

Event type

Enum: DIRECT_DEBIT.NEW
DIRECT_DEBIT.PROCESSING
DIRECT_DEBIT.CONFIRMED
DIRECT_DEBIT.CANCELLED

objectobject

required

idstring

required

Direct debit funding request unique identifier

Format: uuid

created_atstring

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

Format: date-time

user_idstring

required

User unique identifier.

Format: uuid

account_group_idstring

required

Account group unique identifier.

Format: uuid

mandate_idstring

required

Direct Debit Mandate unique identifier.

Format: uuid

cash_amountstring

required

Pattern: ^-?[0-9]{1,9}(\.[0-9]{2})?$

currencystring

required

Alphabetic three-letter ISO 4217 currency code.

EUR - Euro
GBP - Pound Sterling

Enum: EUR
GBP

remittance_informationstring

Pattern: ^[0-9A-Za-z+?/\-:()\.,';_ ]{0,140}$
Max Length: 140

statusstring

Status of the direct debit

NEW - Direct debit is created but not started processing.
PROCESSING - Direct debit is in processing.
CONFIRMED - Direct debit was successfully processed.
CANCELLED - Direct debit was cancelled.

Enum: NEW
PROCESSING
CONFIRMED
CANCELLED

purpose_codestring

Purpose of the payment based on ExternalPurpose1Code from ISO 20022.

Max Length: 4

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "DIRECT_DEBIT.NEW",
  "object": {
    "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
    "created_at": "2020-08-24T14:15:22Z",
    "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
    "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
    "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
    "cash_amount": "200.00",
    "currency": "EUR",
    "remittance_information": "payment for green energy portfolio",
    "status": "NEW"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?