Skip to main content
POST

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Headers

Idempotency-Key
string

Alternative to the idempotency_key body field.

Body

application/json
currency
string
required
Example:

"USD"

type
enum<string>
required
Available options:
TRANSFER,
WITHDRAW
sourceRequisit
object
required
destinationRequisit
object
required
amount
object
required
paymentType
string

EMPTY for TRANSFER; rail code (e.g. SEPA_CT) for WITHDRAW.

comment
string
source_virtual_iban_id
string<uuid>

Optional active banking_eur virtual IBAN used to fund a EUR SEPA Banking withdrawal. Omit only when exactly one active source exists; several sources require this UUID. The platform stamps payer from the vIBAN registrant.

source_instrument_id
string<uuid>

Optional active purpose: banking BO/BOB deposit instrument used as the QR payout source. Outside BO/BOB this field is rejected; multiple active BO sources require this UUID.

beneficiary_type
enum<string>

Required for an EUR SEPA withdrawal; use individual for a person or corporate for a company. Optional for other banking rails.

Available options:
individual,
corporate
beneficiary_given_name
string

Required for a structured individual EUR SEPA beneficiary together with beneficiary_first_surname; optional for other banking rails.

beneficiary_first_surname
string

Required for a structured individual EUR SEPA beneficiary together with beneficiary_given_name; optional for other banking rails.

beneficiary_middle_name
string

Optional middle name for an individual EUR SEPA beneficiary; optional for other banking rails.

beneficiary_name
string

Required company name for a corporate EUR SEPA beneficiary; a multi-word value is also accepted as a compatibility fallback for individual names. Optional for other banking rails.

idempotency_key
string

Response

Idempotency replay of an existing operation (no new charge).

The response is of type object.