Create a USD-source FX rate-hold (USD→EUR/GBP)

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Headers

Idempotency-Key

string

Client-generated idempotency key

Body

application/json

beneficiaryType

enum<string>

required

Beneficiary type (determines amount limits)

Available options:

individual,

business

Example:

"individual"

fromCurrency

string

required

Source currency (currency debited from client)

Example:

"NGN"

targetAmount

string

required

Amount beneficiary receives (in toCurrency)

Example:

"100"

toCurrency

string

required

Target currency (currency beneficiary receives)

Example:

"GBP"

route

enum<string>

Payment rail picked by the customer

Available options:

sepa_inst,

sepa_credit,

paysend,

bank_transfer,

ach,

fedwire,

swift,

crypto

Example:

"swift"

Response

crossRate

string

required

All-in rate: fromCurrency per 1 toCurrency

Example:

"2524.47560000"

expiresAt

string

required

Quote expiry timestamp (ISO 8601)

Example:

"2026-04-13T12:00:30Z"

fee

string

required

Fee amount, denominated in feeCurrency. Dest-currency for cross-rate / same-currency quotes; source-currency (e.g. USD) for a direct USD-source hold whose fee is charged on the source side.

Example:

"0.4000"

feeCurrency

string

required

Currency the fee field is denominated in

Example:

"GBP"

feeInFromCurrency

string

required

Fee amount converted to source currency (fromCurrency)

Example:

"554.8293"

fromCurrency

string

required

Source currency

Example:

"NGN"

string

required

Quote identifier

Example:

"uuid-here"

targetAmount

string

required

Amount beneficiary receives

Example:

"100"

toCurrency

string

required

Target currency

Example:

"GBP"

totalDebitAmount

string

required

Total amount debited from client in fromCurrency

Example:

"252447.5600"

status

enum<string>

Quote status (only included on GET)

Available options:

active,

used,

expired