Sign in
Payment.Settlement Accounts
BETA

Create withdrawal

Creates a withdrawal for the specific transaction, settlement account and merchant.

post/payment/v1/merchants/{merchantId}/accounts/{accountId}/withdrawals

Path parameters

merchantIdstring required

Id of the merchant. Output only.

accountIdstring required

Id of the settlement account. Output only.

Request body

accountIdstring required

Id of the settlement account. Output only.

createdTimestring date-time

The date and time when the withdrawal was initiated. Output only.

idstring

Id of the withdrawal. Output only.

merchantIdstring required

Id of the merchant. Output only.

metadataobject

A key-value dictionary with custom metadata for the withdrawal. All keys and values must be strings. For privacy protection, it is not allowed to use this dictionary for storing personal data (e.g. names and addresses).

referencestring required

External reference set by the merchant, must be between 6-18 characters long.

scheme'SCHEME_UNSPECIFIED' | 'FASTER_PAYMENTS' | 'SEPA_INSTANT_CREDIT_TRANSFER' | 'SEPA_CREDIT_TRANSFER' | 'BACS' | 'CHAPS'

Payment scheme.

  • SCHEME_UNSPECIFIED: Default unspecified scheme.
  • FASTER_PAYMENTS: Faster payments scheme.
  • SEPA_INSTANT_CREDIT_TRANSFER: SEPA Instant Credit Transfer scheme.
  • SEPA_CREDIT_TRANSFER: SEPA Credit Transfer scheme.
  • BACS: BACS scheme.
  • CHAPS: CHAPS scheme.
status'PENDING' | 'COMPLETED' | 'FAILED'

Status of the withdrawal.

  • PENDING: Default value.
  • COMPLETED: Withdrawal was successful.
  • FAILED: Withdrawal failed to complete.
transactionIdstring required

Id of the transaction to determine payee.

updatedTimestring date-time

The date and time when the withdrawal was updated. Output only.

Example request

{
  "accountId": "161ec210-721f-4df5-b21c-f78a9d4c1545",
  "amount": {
    "currencyCode": "EUR",
    "value": {
      "scale": "2",
      "unscaledValue": "5000"
    }
  },
  "createdTime": "2022-07-14T14:01:53Z",
  "id": "b58d313a-b778-4639-8e31-c9ffc35e2d01",
  "merchantId": "e06e47f1-8c88-47ee-9415-a4cde72ae598",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "reference": "Eup7ad0feabb4ab",
  "scheme": "SEPA_INSTANT_CREDIT_TRANSFER",
  "status": "COMPLETED",
  "transactionId": "7ad0feab-bd55-449d-aa7e-b3d3b9c62550",
  "updatedTime": "2022-07-14T14:09:53Z"
}

Response

A successful response.

accountIdstring required

Id of the settlement account. Output only.

createdTimestring date-time

The date and time when the withdrawal was initiated. Output only.

idstring

Id of the withdrawal. Output only.

merchantIdstring required

Id of the merchant. Output only.

metadataobject

A key-value dictionary with custom metadata for the withdrawal. All keys and values must be strings. For privacy protection, it is not allowed to use this dictionary for storing personal data (e.g. names and addresses).

referencestring required

External reference set by the merchant, must be between 6-18 characters long.

scheme'SCHEME_UNSPECIFIED' | 'FASTER_PAYMENTS' | 'SEPA_INSTANT_CREDIT_TRANSFER' | 'SEPA_CREDIT_TRANSFER' | 'BACS' | 'CHAPS'

Payment scheme.

  • SCHEME_UNSPECIFIED: Default unspecified scheme.
  • FASTER_PAYMENTS: Faster payments scheme.
  • SEPA_INSTANT_CREDIT_TRANSFER: SEPA Instant Credit Transfer scheme.
  • SEPA_CREDIT_TRANSFER: SEPA Credit Transfer scheme.
  • BACS: BACS scheme.
  • CHAPS: CHAPS scheme.
status'PENDING' | 'COMPLETED' | 'FAILED'

Status of the withdrawal.

  • PENDING: Default value.
  • COMPLETED: Withdrawal was successful.
  • FAILED: Withdrawal failed to complete.
transactionIdstring required

Id of the transaction to determine payee.

updatedTimestring date-time

The date and time when the withdrawal was updated. Output only.

Example response

{
  "accountId": "161ec210-721f-4df5-b21c-f78a9d4c1545",
  "amount": {
    "currencyCode": "EUR",
    "value": {
      "scale": "2",
      "unscaledValue": "5000"
    }
  },
  "createdTime": "2022-07-14T14:01:53Z",
  "id": "b58d313a-b778-4639-8e31-c9ffc35e2d01",
  "merchantId": "e06e47f1-8c88-47ee-9415-a4cde72ae598",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "reference": "Eup7ad0feabb4ab",
  "scheme": "SEPA_INSTANT_CREDIT_TRANSFER",
  "status": "COMPLETED",
  "transactionId": "7ad0feab-bd55-449d-aa7e-b3d3b9c62550",
  "updatedTime": "2022-07-14T14:09:53Z"
}