Exchange at a fixed rate

Authorizations

X-Processing-Key

string

header

required

Your API key.

Headers

X-Processing-Signature

string

required

Hex-encoded HMAC-SHA512 signature of the request body, generated using your secret key.

Body

application/json

sender_currency

string

required

Currency to exchange from. For a list of all available currencies, see API currency codes.

receiver_currency

string

required

Currency to exchange to. For a list of all available currencies, see API currency codes.

foreign_id

string

required

Unique ID of this exchange in your system, up to 255 characters. It must be unique among your withdrawals and exchanges, and it's case-insensitive.

Maximum string length: 255

price

required

The quote's price from /v2/exchange/calculate (units of receiver_currency for 1 unit of sender_currency), exactly as returned: a rounded value or one with extra trailing zeros doesn't match the quote.

Example:

"0.99978134"

sender_amount

The amount you want to exchange, in sender_currency, as a decimal string (for example, "100") or a number. Include either this parameter or receiver_amount, not both. It must be the amount field and amount of the quote from /v2/exchange/calculate.

Up to 8 decimal places.

receiver_amount

The amount you want to receive, in receiver_currency, before the exchange fee, as a decimal string (for example, "100") or a number. Include either this parameter or sender_amount, not both. It must be the amount field and amount of the quote from /v2/exchange/calculate.

Up to 8 decimal places.

Response

Created

data

object

Hide child attributes

data.id

integer

required

Transaction ID.

data.foreign_id

string

required

This exchange's unique identifier in your system.

data.type

string

required

Transaction type: exchange.

data.sender_amount

string

required

The amount exchanged from sender_currency: the sender_amount from the request, or the amount calculated for the receiver_amount you sent. It doesn't include the exchange fee (see fee_amount).

data.sender_currency

string

required

The currency being exchanged from.

data.receiver_amount

string

required

The amount the exchange gives in receiver_currency: the receiver_amount from the request, or the amount calculated for the sender_amount you sent. It's the amount before the exchange fee: if the fee is charged in receiver_currency, the amount added to your balance is receiver_amount − fee_amount.

data.receiver_currency

string

required

The currency being exchanged to.

data.fee_amount

string

required

The exchange fee. If it's charged in sender_currency, the amount taken from your balance is sender_amount + fee_amount; if it's charged in receiver_currency, the amount added to your balance is receiver_amount − fee_amount. 0.00000000 when no fee is charged, for example for an exchange between the same currency on different networks.

data.fee_currency

string

required

The currency the exchange fee is charged in: sender_currency or receiver_currency.

data.price

string

required

The quoted exchange rate from /v2/exchange/calculate: units of receiver_currency for 1 unit of sender_currency.

Example:

"0.99978134"

data.status

string

required

Exchange status. An exchange callback is sent when the status changes to confirmed.

Reference

Deposits

Withdrawals

Payment requests

Exchanges

Currencies

Transactions

Account balance

System Health

Authorizations

Headers

Body

Response