Exchange
Get an exchange
GET
merchantApiKeymerchantTimestampmerchantNoncemerchantSignatureheader
X-API-KEY<token>Merchant API key (starts with upk_, also accepts api-key); signing headers are also required
header
X-Timestamp<token>Unix timestamp in seconds, within 300 seconds of server time
header
X-Nonce<token>Unique per request; cannot be reused with the same credential during the timestamp validity window
header
X-Signature<token>Hex HMAC-SHA256 signature (either letter case) of the method, full path, timestamp, nonce and body digest
exchangeId*stringExchange
application/json- response
id*stringExchange ID (starts with exc_)
quote_id*stringstatus*ExchangeStatuspending: sell amount held, waiting for the provider's resultcompleted: completed and bookedfailed: failed, seefailure_reason; the held amount is released and no fee is charged
Value in
"pending""completed""failed"sell_amount*stringsell_currency*stringbuy_amount*stringAmount the merchant receives; for provider exchanges, updated to what the provider actually filled on completion
buy_currency*stringrate*stringSame as the quote's rate
fee*stringSame as the quote's fee
fee_currency*stringfailure_reason*string|nullcreated_at*stringFormat
date-timecompleted_at*|Format
date-timecurl -X GET 'https://sandbox.getupp.net/api/v1/exchanges/string'Example Response
{ "id": "string", "quote_id": "string", "status": "pending", "sell_amount": "string", "sell_currency": "string", "buy_amount": "string", "buy_currency": "string", "rate": "string", "fee": "string", "fee_currency": "string", "failure_reason": "string", "created_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z"}