VOvopay
SEPA Endpoints

sepa/withdraw

This endpoint debits your account by sending a SEPA Instant payment to a creditor's IBAN. Only EUR currency is supported. Requires SEPAInstantWithdrawEnabled permission and an active EUR virtual account.

post/sepa/withdraw

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/sepa/withdraw
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Amountnumber required

The amount to send via SEPA Instant payment

RecipientNamestring required

The full name of the recipient (creditor)

IBANstring required

The recipient's International Bank Account Number (IBAN)

Currencystring

The currency for the transaction. Must be EUR

ClientAccountIDstring

The ID of the client account to associate with this transaction

ClientReferenceNumberstring

An optional reference number for your own records

IdempotencyKeystring

A unique key to ensure idempotent request processing

Notesstring

Optional notes to attach to the transaction

ParentTransactionIDstring

The ID of a parent transaction to link this transaction to

GLCodestring

General ledger code for accounting purposes

TransactionTypeCodestring

A custom transaction type code for categorization

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

TransactionIDinteger required

The unique ID for the SEPA withdrawal transaction

TransactionStatusstring required

The current status of the transaction

Flaggedstring

Present if the transaction was flagged. Contains flag status messages

Noticestring

Present if the account has insufficient funds at the time of the transaction

Example response

{
  "Success": true,
  "TransactionStatus": "pending"
}

Changes

No recorded changes to this operation across all 1 revision of this API.