Skip to main content
POST
/
api
/
service
/
fx
/
retrieve
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});

const fx = await client.fx.retrieve({ fxId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

console.log(fx.id);
{
  "id": "<string>",
  "rate": "<string>",
  "targetAmount": "<string>",
  "sourceAmount": "<string>",
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
​
fxId
string<uuid>
required

The fxId attached to the transfer.

Response

200 - application/json

FX details retrieved 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.