API Endpoint: https://api.swup.ai/
\nPHP client example: https://github.com/swup-dev/Swup-PHP-SDK
\nNode.JS client example: https://github.com/swup-dev/Swup-Node.js-SDK
\nEach request must be sent with headers:
\nx-merchant-id - Your merchant ID.
\nx-nonce - Unique request ID
\nx-merchant-signature - Request signature
\nHash value with secret key by sha256 hashing algorithm, value x-nonce + json_string_data.
\nExample**:**
\nx-nonce = NONCE_VAL
json_string_data = {\"amount\":\"100\",\"currency\":\"USDT_TRX\",\"address\":\"TMzz9MrUhHMBDZwDsX1PAJ3wVDBXdEm9iN\",\"externalId\":\"333311\"}. Note: If data is empty or method is GET use {} instead of []
secret key = SECRET_KEY
x-nonce + json_string_data = NONCE_VAL{\"amount\":\"100\",\"currency\":\"USDT_TRX\",\"address\":\"TMzz9MrUhHMBDZwDsX1PAJ3wVDBXdEm9iN\",\"externalId\":\"333311\"}
singnature = CALCULATED_SIGNATURE
Currency must be transferred in the format:
\nfor coin: e.g. TRX, BTC, ETH etc;
for token, token_token-standard: e.g. USDT_ERC-20, USDC_TRC-20 etc.
Callbacks come to the callbackUrl specified in the invoice or, if not specified, to the callbackUrl from the merchant's settings.
You will get JSON with invoice structure like in Get invoice by ID endpoint. Each callback will contain a signature, it is generated according to the principles described in the Authentication block. You must generate a request signature from your side and compare your hash and the hash from the headers (x-merchant-signature) using the x-nonce from the headers, for key pair with x-merchant-id from headers.
Callbacks will be sent until they receive a successful response (status code 2xx). There are 10 attempts to send a callback to get a successful response.
\nImmediately after invoice update;
\n1 minute after sending the last callback;
\n3 minutes after sending the last callback;
\n5 minutes after sending the last callback;
\n10 minutes after sending the last callback;
\n20 minutes after sending the last callback;
\n30 minutes after sending the last callback;
\n1 hour after sending the last callback;
\n2 hours after sending the last callback;
\n3 hours after sending the last callback;
\nYour merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"321\",\n \"amount\": \"500\",\n \"amountCurrency\": \"TRX\",\n \"currency\": \"USDT_TRC-20\",\n \"title\": \"TRON_PAYMENT\",\n \"description\": \"BUY_CAR\",\n \"errorUrl\": \"https://swup_payments.requestcatcher.com/\",\n \"successUrl\": \"https://swup_payments.requestcatcher.com/\",\n \"callbackUrl\": \"https://swup_payments.requestcatcher.com/\",\n \"expiresAfter\": 100\n}"},"url":"{{payments_api_url}}merchant/invoices","description":"The API endpoint creates a invoice.
\nYour merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"url":"{{payments_api_url}}merchant/invoices/{id}","description":"The API endpoint returns a invoice by ID.
\npending - Awaiting payment;
expired - time to pay is over;
success - fully paid;
partial_paid - partial paid;
refunded - invoice refunded.
Your merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"200\",\n \"address\": \"TMzz9MrUhHMBDZwDsX1PAJ3wVDBXdEm9iN\",\n \"currency\": \"USDT_TRC-20\",\n \"externalId\": \"456\",\n \"destinationTag\": null,\n \"clientFee\": true\n}"},"url":"{{payments_api_url}}merchant/withdrawals","description":"The API endpoint creates a crypto withdrawal.
\nYour merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"100\",\n \"currency\": \"INR\",\n \"externalId\": \"456\",\n \"destinationTag\": null,\n \"clientFee\": true,\n \"accountHolder\": \"John Wick\",\n \"accountNumber\": \"4444444444444444\",\n \"ifscCode\": \"1234567\",\n \"callbackUrl\": \"https://your-domain/callback\",\n \"expire\": \"2025\",\n \"clientIp\": \"127.0.0.1\"\n}"},"url":"{{payments_api_url}}merchant/withdrawals/fiat","description":"The API endpoint creates a fiat withdrawal.
\nYour merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"url":"{{payments_api_url}}merchant/withdrawals/{id}","description":"The API endpoint returns a withdrawal by ID.
\nnew - Withdrawal request created;
processing - withdrawal processing;
completed - withdrawal completed;
rejected - withdrawal rejected (system problems).
local - Withdrawals created from merchant dashboard;
external - withdrawals created from merchant API;
invoice_refund - withdrawals created from invoice refund.
Your merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"url":"{{payments_api_url}}merchant/exchanges/min-amount?fromCurrency=USD&toCurrency=BTC&flow=float_rate","description":"The API endpoint returns the minimum amount for an exchange pair.
\nfloat_rate, fix_rate
\n","type":"text/plain"},"key":"flow","value":"float_rate"}],"variable":[]}},"response":[{"id":"7f97e662-b2d7-45e4-8505-76962929b61c","name":"Get exchange min amount","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-merchant-id","value":"{{merchant_id}}","description":"Your merchant API ID","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID","type":"text"}],"url":{"raw":"{{payments_api_url}}merchant/exchanges/min-amount?fromCurrency=USD&toCurrency=BTC&flow=float_rate","host":["{{payments_api_url}}merchant"],"path":["exchanges","min-amount"],"query":[{"key":"fromCurrency","value":"USD"},{"key":"toCurrency","value":"BTC"},{"key":"flow","value":"float_rate","description":"float_rate, fix_rate"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"errors\": [],\n \"data\": {\n \"minAmount\": \"10\"\n }\n}"}],"_postman_id":"52f1d369-eded-4995-9cbd-1feec573e4db"},{"name":"Get exchange estimated amount","id":"ee8b74e8-652b-43ee-89e1-2127359769d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-merchant-id","value":"{{merchant_id}}","description":"Your merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"url":"{{payments_api_url}}merchant/exchanges/estimated-amount?fromCurrency=USD&toCurrency=BTC&flow=float_rate&amount=200000","description":"The API endpoint returns the estimated exchange amount.
\nfloat_rate, fix_rate
\n","type":"text/plain"},"key":"flow","value":"float_rate"},{"key":"amount","value":"200000"}],"variable":[]}},"response":[{"id":"3dc07b08-d97c-423a-857c-5eb675e344f2","name":"Get exchange estimated amount","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-merchant-id","value":"{{merchant_id}}","description":"Your merchant API ID","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID","type":"text"}],"url":{"raw":"{{payments_api_url}}merchant/exchanges/estimated-amount?fromCurrency=USD&toCurrency=BTC&flow=float_rate&amount=200000","host":["{{payments_api_url}}merchant"],"path":["exchanges","estimated-amount"],"query":[{"key":"fromCurrency","value":"USD"},{"key":"toCurrency","value":"BTC"},{"key":"flow","value":"float_rate","description":"float_rate, fix_rate"},{"key":"amount","value":"200000"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"errors\": [],\n \"data\": {\n \"rateId\": \"QpMEeFfv7PTQbQOBDdhH6AmsbMIcrUzW\",\n \"convertFee\": \"12.4000000000\",\n \"estimatedAmount\": \"107.6000000000\"\n }\n}"}],"_postman_id":"ee8b74e8-652b-43ee-89e1-2127359769d3"},{"name":"Create exchange","id":"a2c471e7-ac93-42ba-b4f3-07c027efe73c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-merchant-id","value":"{{merchant_id}}","description":"Your merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"200\",\n \"rateId\": \"wSvUTOustUcpWat71uhm5nnL9nkSMLmq\",\n \"fromCurrency\": \"USD\",\n \"externalId\": \"456\",\n \"toCurrency\": \"BTC\"\n}"},"url":"{{payments_api_url}}merchant/exchange","description":"The API endpoint creates a exchange.
\nYour merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"url":"{{payments_api_url}}merchant/exchanges/{id}","description":"The API endpoint returns a exchange by ID.
\nlocal - Exchanges created from merchant dashboard;
external - exchanges created from merchant API;
auto - exchanges created from invoice.
new - Exchange request created;
processing - exchange processing;
completed - exchange completed;
rejected - exchange rejected (system problems).
Your merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"url":"{{payments_api_url}}merchant/balances","description":"The API endpoint returns balances.
\nYour merchant API ID
\n","type":"text"},{"key":"x-merchant-signature","value":"CALCULATED_SIGNATURE","description":"Signature current request
\n","type":"text"},{"key":"x-nonce","value":"NONCE_VAL","description":"Unique request ID
\n","type":"text"}],"url":"{{payments_api_url}}merchant/exchange-rates","description":"The API endpoint returns exchange rates.
\n