ReDoc documentation
Download OpenAPI specification:Download
[- {
- "id": "BTC",
- "type": "coin",
- "blockchain": "bitcoin"
}, - {
- "id": "USDC",
- "type": "token",
- "blockchain": "ethereum",
- "chainId": 1,
- "contract": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
}
]
[- {
- "from": "btc",
- "to": "bat",
- "tradeMethod": [
- "fixed",
- "float"
], - "minSwapAmount": "1",
- "maxSwapAmount": "20"
}, - {
- "from": "bat",
- "to": "btc",
- "tradeMethod": [
- "fixed",
- "float"
], - "minSwapAmount": "5",
- "maxSwapAmount": "10"
}
]
Return a quote for a pair and amount.
Information required for generating the payload.
OK
This error indicates a violation of one or more constraints within the partner's system regarding the quote request. It is essential for the partner to specify the breached constraint to facilitate correction of the request. You can express any other constraints in your system by extending the error payload.
The pair might be currently unavailable on your end, or you might not recognize one of the currencies. Please add relevant details about the causes.
User's IP address or currency is in a restricted region.
{- "from": "btc",
- "to": "eth",
- "amount": "1"
}
{- "quoteId": "CC14E626-CF1B-4EDA-AF5E-766FFD5A3457",
- "amount": "1",
- "amountTo": "270.864632",
- "providerFees": "0.0001",
- "referralFees": "0.0001",
- "payoutNetworkFees": "0.0002",
- "tradeMethod": "float",
- "expiry": "2022-04-04T09:10:51+0000",
- "minAmountFrom": "1",
- "maxAmountFrom": "3",
- "defaultSlippage": "0.1",
- "minSlippage": "0.1",
- "maxSlippage": "0.3"
}
Generates a secure binary payload for the nano in order to authorize the transaction.
/quote
). The partner should retrieve the quote data (amounts…) from this id.Info for generating payload
OK
Deposit wallet not available.
Not found error.
When the user's IP address is in a restricted region.
{- "quoteId": "string",
- "refundAddress": "string",
- "payoutAddress": "string",
- "refundAddressExtraId": "string",
- "payoutAddressExtraId": "string",
- "currencyFrom": "string",
- "currencyTo": "string",
- "payloadCurrencyFrom": "string",
- "payloadCurrencyTo": "string",
- "nonce": "string",
- "slippage": "string"
}
{- "swapId": "SWAP-ID-165940",
- "payinAddress": "0xa0b86991c627e936c1d19d4a2e90a2ce3606eb48",
- "createdAt": "2030-05-26T14:13:39",
- "providerFees": "0.0001",
- "referralFees": "0.0001",
- "payoutNetworkFees": "0.0002",
- "providerSig": {
- "payload": "CgUweGZmZhoFMHhmZmYqBTB4ZmZmOgNCVENCA0JBVEoIMTIwMDAwMDBSCDExNTAwMDAwWhF2ZXJ5IGxvbmd1ZSBub25jZQ==",
- "payload_signature": "MEUCIBRm4PrdgRw0aBwRepuOGGRmR/YPcCoyKNJ7UDjFO030AiEA/VT0anolum0a3X/9lGPeovZHqzeDG9brcUB4zhYmwbs="
}
}
Generates a secure binary payload for the nano in order to authorize the transaction.
Info for generating payload
OK
Deposit wallet not available.
When the user's IP address is in a restricted region.
{- "amount": "string",
- "refundAddress": "string",
- "payoutAddress": "string",
- "refundAddressExtraId": "string",
- "payoutAddressExtraId": "string",
- "currencyFrom": "string",
- "currencyTo": "string",
- "payloadCurrencyFrom": "string",
- "payloadCurrencyTo": "string",
- "nonce": "string",
- "slippage": "string"
}
{- "swapId": "SWAP-ID-165940",
- "payinAddress": "0xa0b86991c627e936c1d19d4a2e90a2ce3606eb48",
- "createdAt": "2030-05-26T14:13:39",
- "providerFees": "0.0001",
- "referralFees": "0.0001",
- "payoutNetworkFees": "0.0002",
- "providerSig": {
- "payload": "CgUweGZmZhoFMHhmZmYqBTB4ZmZmOgNCVENCA0JBVEoIMTIwMDAwMDBSCDExNTAwMDAwWhF2ZXJ5IGxvbmd1ZSBub25jZQ==",
- "payload_signature": "MEUCIBRm4PrdgRw0aBwRepuOGGRmR/YPcCoyKNJ7UDjFO030AiEA/VT0anolum0a3X/9lGPeovZHqzeDG9brcUB4zhYmwbs="
}
}
Returns the status of a quote / trade being executed.
OK
Swap transaction not found.
{- "status": "PENDING",
- "amount": "1.337",
- "payinTransactionId": "0xfffffffffffff",
- "payoutTransactionId": "0xfffffffffffff",
- "providerFees": "0.0001",
- "referralFees": "0.0001",
- "payoutNetworkFees": "0.0002"
}