Sign in
latestOpenAPI 3.0.12026-08-104242199.9 KB

8df83424e244

Clearing transactions

Create debit clearing transaction

Creates a debit clearing transaction to the account specified in the request URL. Funds will be drawn from the account defined in the clearing profile to the account in the URL.

post/v1/accounts/{account_id}/debit_clearing_transactions

Path parameters

account_idstring required

Request body

booking_typestring required

The booking type to use for the debit clearing transaction. Must match one of the booking types defined in the clearing profile.

descriptionstring

A description for the transaction.

clearing_profile_idstring required

ID of the clearing profile to use for the debit clearing transaction.

referencestring

A unique reference for the transaction.

initiator_referencestring

Optional unique initiator reference for the transaction.

Example request

{
  "amount": {
    "value": 1000,
    "currency": "EUR",
    "unit": "cents"
  },
  "booking_type": "INTEREST_ACCRUED",
  "description": "Example clearing transaction",
  "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
  "reference": "ert123456789ert",
  "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}

Response

The operation was successful.

idstring

ID of the clearing transaction.

status'ACCEPTED' | 'DECLINED' | 'EXECUTED' | 'REVIEW_NEEDED' | 'CANCELED'

The status of the clearing transaction.

account_idstring

ID of the account for which the transaction was created.

account_ibanstring

The account's IBAN.

clearing_account_ibanstring

The clearing account's IBAN.

descriptionstring

A description of the transaction, which is visible to both the sender and the receiver.

booking_type'CANCELLATION_BOOKING' | 'CancellationCardTransaction' | 'CANCELLATION_CARD_TRANSACTION_DIRECT' | 'CANCELLATION_CHARGE_CARD' | 'CANCELLATION_CHARGE_DUNNING' | 'CANCELLATION_CHARGE_SEPA_DIRECT_DEBIT_RETURN' | 'CANCELLATION_CRYPTO_EXCHANGE' | 'CANCELLATION_CURRENCY_EXCHANGE_PARTNER' | 'CANCELLATION_DIRECT_DEBIT' | 'CANCELLATION_DOUBLE_BOOKING' | 'CANCELLATION_INTERNAL_TRANSFER' | 'CANCELLATION_INTERNATIONAL_CREDIT_TRANSFER' | 'CANCELLATION_INTEREST_ACCRUED' | 'CANCELLATION_INTEREST_ANNUITY' | 'CANCELLATION_INTEREST_LOAN' | 'CANCELLATION_LOAN_PAYOUT' | 'CANCELLATION_REBOOKING' | 'CANCELLATION_REBOOKING_INTEREST' | 'CANCELLATION_SEPA_CREDIT_TRANSFER_RETURN' | 'CANCELLATION_SEPA_DIRECT_DEBIT' | 'CANCELLATION_SEPA_DIRECT_DEBIT_RETURN' | 'CANCELLATION_TRANSFER_ANNUITY' | 'CARD_DIRECT_DEBIT' | 'CARD_TRANSACTION' | 'CARD_TRANSACTION_DIRECT' | 'CASH_DEPOSIT_RETAIL' | 'CASH_WITHDRAWAL_RETAIL' | 'CHARGE_ACCOUNT_MAINTENANCE' | 'CHARGE_CARD' | 'CHARGE_DUNNING' | 'ChargeRecallRequest' | 'CHARGE_SEPA_DIRECT_DEBIT_RETURN' | 'ClosureBalanceTransfer' | 'COMMISSION_OVERDRAFT' | 'CREDIT_TRANSFER_CANCELLATION' | 'CRYPTO_EXCHANGE' | 'CURRENCY_EXCHANGE_PARTNER' | 'DIRECT_DEBIT' | 'FOREIGN_PAYMENT' | 'INTEREST_ACCRUED' | 'INTEREST_ANNUITY' | 'INTEREST_LOAN' | 'INTERNAL_TRANSFER' | 'INTERNATIONAL_CREDIT_TRANSFER' | 'LOAN_PAYOUT' | 'REBOOKING' | 'REBOOKING_INTEREST' | 'SEPA_CREDIT_TRANSFER' | 'SEPA_CREDIT_TRANSFER_RETURN' | 'SEPA_DIRECT_DEBIT' | 'SEPA_DIRECT_DEBIT_RETURN' | 'SEPAInstantCreditTransfer' | 'SepaInstantCreditTransferReturn' | 'TARGET2_CREDIT_TRANSFER' | 'TRANSFER_ANNUITY' | 'OTHER'

The type of the booking. See the booking documentation for a list of explanations for each booking type.

valuta_datestring

The valuta date of the transaction.

transaction_typestring

The type of the transaction.

referencestring

UUID reference for the transaction. Acts as an idempotency key.

initiator_referencestring

UUID initiatiors reference for the transaction.

Example response

{
  "id": "3f4e761f500e4c11a6627b4d90daaec4",
  "status": "EXECUTED",
  "account_id": "06659ff514934b28800b5650d109cacc",
  "account_iban": "DE43110101005555555555",
  "clearing_account_iban": "DE30110101001234567890",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "Example description",
  "booking_type": "SEPA_CREDIT_TRANSFER",
  "valuta_date": "2022-04-22",
  "transaction_type": "CLEARING_TRANSACTION",
  "reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f",
  "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}