Payments

Withdrawals

Download Spec

All withdrawals related paths

post/payments/withdrawals

Trigger a withdrawal

reference_account_idstring

required

Reference account unique identifier.

Format: uuid

account_group_idstring

required

Account group unique identifier.

Format: uuid

user_idstring

required

User unique identifier.

Format: uuid

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 credit transfer 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

{
  "reference_account_id": "295378ec-036e-4f3f-ae5c-2be85c93e837",
  "account_group_id": "2596db3b-0d03-4651-9eda-970910479dfb",
  "user_id": "e56c14b3-8370-4c04-bc67-7092f7ec113c",
  "amount": "200.00",
  "currency": "EUR",
  "remittance_information": "Withdrawal",
  "purpose_code": "OTHR"
}

Response examples

Withdrawal

{
  "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "reference_account_id": "295378ec-036e-4f3f-ae5c-2be85c93e837",
  "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c",
  "user_id": "b668282b-cdf3-439a-bda2-3f3c9f655bb7",
  "amount": "200.00",
  "currency": "EUR",
  "remittance_information": "Withdrawal",
  "taxes": [
    {
      "type": "TOTAL",
      "amount": "38.00",
      "currency": "EUR"
    }
  ],
  "status": "NEW",
  "purpose_code": "OTHR"
}

get/payments/withdrawals/{withdrawal_id}

Retrieve withdrawal

withdrawal_idstring

required

Cash withdrawal unique identifier

Format: uuid

Responses

Response examples

Withdrawal

{
  "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "reference_account_id": "295378ec-036e-4f3f-ae5c-2be85c93e837",
  "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c",
  "user_id": "b668282b-cdf3-439a-bda2-3f3c9f655bb7",
  "amount": "200.00",
  "currency": "EUR",
  "remittance_information": "Withdrawal",
  "taxes": [
    {
      "type": "TOTAL",
      "amount": "38.00",
      "currency": "EUR"
    }
  ],
  "status": "CONFIRMED",
  "purpose_code": "OTHR"
}

delete/payments/withdrawals/{withdrawal_id}

Cancel withdrawal by ID

Cancels a withdrawal specified by its ID. It is only possible to cancel a withdrawal if it has the status NEW.

withdrawal_idstring

required

Cash withdrawal unique identifier

Format: uuid

Responses

Response examples

Request has been processed successfully.

Empty response

get/account_groups/{account_group_id}/payments/withdrawals

List withdrawals

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

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

limitint

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

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

Responses

Response examples

Withdrawals list

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1
  },
  "data": [
    {
      "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
      "created_at": "2020-08-24T14:15:22Z",
      "updated_at": "2020-08-24T14:15:22Z",
      "reference_account_id": "295378ec-036e-4f3f-ae5c-2be85c93e837",
      "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c",
      "user_id": "b668282b-cdf3-439a-bda2-3f3c9f655bb7",
      "amount": "200.00",
      "currency": "EUR",
      "remittance_information": "Withdrawal",
      "taxes": [
        {
          "type": "TOTAL",
          "amount": "38.00",
          "currency": "EUR"
        }
      ],
      "status": "CONFIRMED",
      "purpose_code": "OTHR"
    }
  ]
}

webhook

Withdrawals 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: WITHDRAWAL.NEW
WITHDRAWAL.PROCESSING
WITHDRAWAL.CONFIRMED
WITHDRAWAL.CANCELLED

objectobject (Payments - Withdrawal)

required

idstring

required

Cash withdrawal unique identifier

Format: uuid

created_atstring

required

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

Format: date-time

updated_atstring

required

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

Format: date-time

reference_account_idstring

required

Reference account unique identifier.

Format: uuid

account_group_idstring

required

Account group unique identifier.

Format: uuid

user_idstring

required

User unique identifier.

Format: uuid

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

required

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

taxesarray

statusstring

Status of the withdrawal

NEW - Withdrawal is created but not started processing.
PROCESSING - Withdrawal is in processing.
CONFIRMED - Withdrawal was successfully processed.
CANCELLED - Withdrawal 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": "WITHDRAWAL.NEW",
  "object": {
    "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
    "created_at": "2020-08-24T14:15:22Z",
    "updated_at": "2020-08-24T14:15:22Z",
    "reference_account_id": "295378ec-036e-4f3f-ae5c-2be85c93e837",
    "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c",
    "user_id": "b668282b-cdf3-439a-bda2-3f3c9f655bb7",
    "amount": "200.00",
    "currency": "EUR",
    "remittance_information": "Withdrawal",
    "taxes": [
      {
        "type": "TOTAL",
        "amount": "38.00",
        "currency": "EUR"
      }
    ],
    "status": "NEW"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?