Skip to main content
POST
JavaScript

Authorizations

X-Ivy-Api-Key
string
header
required

API key for authentication

Headers

Idempotency-Key
string

Idempotency key for safe retries. Takes precedence over the deprecated body field.

Body

application/json
sourceAmount
string
required

The amount of source currency to convert. Minimum: 10

sourceAccountId
string<uuid>
required

The source account id.

targetAccountId
string<uuid>
required

The target account id.

idempotencyKey
string

Deprecated: use the Idempotency-Key request header instead.

metadata
object

Additional metadata.

Response

200 - application/json

FX executed successfully

id
string
required

The fxId attached to the transfer.

rate
string
required

The exchange rate for the given currency pair.

sourceCurrency
enum<string>
required

The source currency code

Available options:
EUR,
GBP,
USDC
targetCurrency
enum<string>
required

The target currency code

Available options:
EUR,
GBP,
USDC
status
enum<string>
required

The status of the FX transaction.

Available options:
initiated,
succeeded,
failed
targetAmount
string

The amount of the target currency for the given source amount.

sourceAmount
string

The amount of source currency to convert.

metadata
object

Additional metadata.