Sells amount of the IBAN's asset (at least minimum, 100) and pays the proceeds by SEPA to destination, in the IBAN's currency. amount plus the fee in the asset 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

NameInTypeRequiredDescription
companyId path string (uuid) yes

Your company that Payca enabled for Virtual IBAN.
ibanId path string (uuid) yes

The id of one of your IBANs from GET …/ibans.
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 idempotency_conflict.

Request body

application/json · object · required

FieldTypeRequiredDescription
amount VirtualIbanAmount yes
destination VirtualIbanDestination yes
expectedFee string yes

The fee from the quote for this amount.

Responses

StatusBodyDescription
202 VirtualIbanWithdrawal

Accepted; follow it with GET …/fiat-payouts/{payoutId}.
400 VirtualIbanError

The request was refused; code says why (see errors).
401 —

Missing or invalid x-client-id / x-client-secret (no body).
403 VirtualIbanError

The request was refused; code says why (see errors).
404 VirtualIbanError

The request was refused; code says why (see errors).
409 VirtualIbanError

The request was refused; code says why (see errors).
503 VirtualIbanError

The request was refused; code says why (see errors).

Specification

This page is generated from the OpenAPI specification, which remains the authoritative machine-readable source.