Skip to main content
POST
Create a virtual bank account for a customer. The customer must have an approved endorsement for the currency (see GET /business/virtual-account/currencies-and-endorsements) before a virtual account can be issued.
Requires an Idempotency-Key header. Each customer can hold one virtual account per currency.

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Headers

Idempotency-Key
string
required

A unique string per request to ensure idempotent processing.

Body

application/json
currency
string
required

Currency code for the virtual account, for example USDBASE, EURBASE, MXN or BRL. GET /business/virtual-account/currencies-and-endorsements returns every code your account can use and the endorsement each one needs.

Example:

"BRL"

customer_id
string<uuid>

The UUID of the KYC-approved customer. Required when currency is USD; optional for other currencies.

Response

201 - application/json

Virtual account creation in progress

status
string
status_code
integer
message
string
data
object