Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Headers

Idempotency-Key
string

Optional idempotency key: any string, a UUID v4 is recommended. Resending the same key with a different request body is a conflict. Cached responses include the header X-Idempotent-Cached: true. Keys expire after 24 hours.

Body

application/json

Exchange rate's type is FLOATING: an indicative rate, not stored.

customerId
string<uuid>
required

Customer's unique identifier. The customer needs an active account in the fiat currency of the pair.

Example:

"992f6325-fdd9-410d-803c-2ec0f30e1d74"

rail
enum<string>
required

Payment rail. Each rail settles one fiat currency: PIX: BRL, SPEI: MXN, SEPA: EUR, FPS: GBP, SWIFT, FEDWIRE and ACH: USD. The rail must be enabled for your project.

Available options:
PIX,
SWIFT,
SEPA,
FEDWIRE,
ACH,
SPEI,
FPS
Example:

"PIX"

sourceCurrency
enum<string>
required

Exchange rate's source currency. One side of the pair must be a fiat currency and the other a stablecoin. A fiat source means an on-ramp quote; a stablecoin source means an off-ramp quote.

Available options:
BRL,
USD,
EUR,
MXN,
GBP,
USDC,
USDT
Example:

"BRL"

sourceAmount
string
required

Exchange rate's source amount. Fiat amounts accept up to 2 decimal places. Must be worth at least 50 USD.

Example:

"1000.00"

targetCurrency
enum<string>
required

Exchange rate's target currency. See sourceCurrency.

Available options:
BRL,
USD,
EUR,
MXN,
GBP,
USDC,
USDT
Example:

"USDC"

type
enum<string>

Exchange rate's type. Case-insensitive. Defaults to FLOATING.

Available options:
FLOATING
Example:

"FLOATING"

blockchain
enum<string>

Blockchain network. Accepted values depend on the networks enabled for your project. Case-insensitive. When omitted, your project's default blockchain is used.

Available options:
ETHEREUM,
POLYGON,
BASE,
TRON,
STELLAR
Example:

"POLYGON"

partnerFeeId
string<uuid>

Partner fee's unique identifier.

Example:

"64cd84f0-a99d-422b-82e8-89d3595251b9"

Response

Exchange rate successfully created.

Exchange rate's type is FLOATING.

type
enum<string>

Exchange rate's type.

Available options:
FLOATING
Example:

"FLOATING"

rail
enum<string>

Payment rail. Each rail settles one fiat currency: PIX: BRL, SPEI: MXN, SEPA: EUR, FPS: GBP, SWIFT, FEDWIRE and ACH: USD. The rail must be enabled for your project.

Available options:
PIX,
SWIFT,
SEPA,
FEDWIRE,
ACH,
SPEI,
FPS
Example:

"PIX"

blockchain
string

Exchange rate's blockchain. The one requested, or your project's default.

Example:

"POLYGON"

sourceCurrency
string

Exchange rate's source currency.

Example:

"BRL"

sourceAmount
string

Exchange rate's source amount. Fiat amounts have 2 decimal places, stablecoin amounts 6. For a locked rate requested by targetAmount, this is the amount the customer must send.

Example:

"1000.00"

targetCurrency
string

Exchange rate's target currency.

Example:

"USDC"

baseExchangeRate
string

Exchange rate's base rate before fees, in target currency units per source currency unit.

Example:

"0.181900"

baseTargetAmount
string

Exchange rate's target amount before fees.

Example:

"181.900000"

fees
object

Fees charged on the operation.

finalTargetAmount
string

Exchange rate's target amount after fees.

Example:

"178.626700"

finalExchangeRate
string

Exchange rate's effective rate after fees (finalTargetAmount / sourceAmount).

Example:

"0.178627"