Sends amount of the IBAN's asset (USDC or USDT) on Polygon to an active entry of your address book. amount plus the fee, both in the asset, is reserved on the IBAN balance at once and spent once the transfer is confirmed on the chain; if it fails, both return to the balance. The fee is tariff.payout applied to the amount, in the asset; send it as expectedFee (fee_changed otherwise).

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
addressId string (uuid) yes

An active entry of your address book.
amount VirtualIbanAmount yes
expectedFee string yes

The fee in the asset for this amount.

Responses

StatusBodyDescription
202 VirtualIbanWithdrawal

Accepted; follow it with GET …/crypto-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.