Sells amount of the account's coin (at least the account's
fiatMinimums for currency, the quote's minimum) and pays the
proceeds to destination in currency, from either coin and whatever
IBANs the company has: EUR by SEPA (VirtualIbanDestination), USD to a
US bank account (rail: us_domestic) or abroad by SWIFT (rail: swift)
(VirtualIbanUSDDestination). A destination of the other currency's
shape is invalid_request; for a USD destination detail names the
field (destination.routingNumber must be a valid 9-digit ABA routing number). Offered in the currencies the account lists in
withdrawals.fiatCurrencies. amount plus the fee in the coin is
reserved at once and spent when the payout settles; the amount paid out
is what the sale yields, shown as fiatAmount once completed. It takes
hours, up to a day. Retries are safe with the same Idempotency-Key.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
companyId |
path | string (uuid) |
yes | Your company that Payca enabled for Virtual IBAN. |
accountId |
path | string (uuid) |
yes | The |
Idempotency-Key |
header | string |
yes | Your unique key for this operation, 1–128 characters. The same key returns the same result; a different body under it is |
Request body
application/json
· object
· required
| Field | Type | Required | Description |
|---|---|---|---|
amount |
VirtualIbanAmount |
yes | |
currency |
string |
yes | The currency paid out; it decides the shape of |
destination |
VirtualIbanDestination or VirtualIbanUSDDestination |
yes | SEPA for EUR; |
expectedFee |
string |
yes | The |
Responses
| Status | Body | Description |
|---|---|---|
202 |
VirtualIbanWithdrawal |
Accepted; follow it with |
400 |
VirtualIbanError |
The request was refused; |
401 |
— | Missing or invalid |
403 |
VirtualIbanError |
The request was refused; |
404 |
VirtualIbanError |
The request was refused; |
409 |
VirtualIbanError |
The request was refused; |
503 |
VirtualIbanError |
The request was refused; |
Specification
This page is generated from the OpenAPI specification, which remains the authoritative machine-readable source.