Moves amount of the account's coin (USDC or USDT) to your own active USD account in Payca, at once, one for one (1 USDC or USDT = 1 USD) and without a fee. Offered when the account says usdTransfer: true; otherwise 403 capability_disabled (Payca enables it for you on request). The target must be a USD account of the company's owner: your own USD account for a company of your integration, the cabinet user's for a cabinet company. Not enough on the account is banking_rejected; it never goes below zero.

Retries are safe with the same Idempotency-Key; the same key with a different body is idempotency_conflict.

Parameters

NameInTypeRequiredDescription
companyId path string (uuid) yes

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

The id of one of your crypto accounts, from GET …/crypto-accounts.
Idempotency-Key header string yes

Your unique key for this operation, 1–128 characters.

Request body

application/json · object · required

FieldTypeRequiredDescription
amount string yes

Amount of the account's coin, positive, at most two decimals; the same amount in USD is credited. A JSON number is accepted too.
toAccountId string (uuid) yes

Your active USD account to credit.

Responses

StatusBodyDescription
200 VirtualIbanUsdTransfer

Transfer done (or the transfer this key already made).
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.