User picks a currency in your UI.
\nYour system sends Create Deposit with the selected token + chain and a unique externalTxId.
We immediately return a fresh deposit address (and QR) + the expected token amount calculated from your local currency.
\nYou show the address/QR/expected amount to the user and wait for the transfer.
\nAfter the blockchain confirmation, we POST a callback to your URL. If no payment arrives within the agreed window, the session expires.
\nTip: Use GET /api/public/supported-currencies to build your currency selector. Always send token + chain from that list (never send label).
EndpointPOST {{baseUrl}}/api/deposit/request
Headers
\nContent-Type: application/json
x-api-key: {{apiKey}} (required; your API key must also be IP-allowlisted)
Request Body (example)
\n{\n \"externalTxId\": \"ext-tx-0024234\",\n \"token\": \"usdt\",\n \"currencyInLocal\": \"TRY\",\n \"chain\": \"tron\",\n \"amountInLocal\": 1000\n}\n\nFields
\nexternalTxId (string, required) – Unique per request. Use this to reconcile in your system.
token (string, required) – From discovery (usdt, eth, …).
chain (string, required) – From discovery (tron, eth, …).
currencyInLocal (string, required) – ISO-4217 (e.g., TRY, USD).
amountInLocal (number, required) – Amount in the local currency above.
200 OK – Success Response
\nWe generate a new, unique address per request.
\n{\n \"depositAddress\": \"TJXkjYHDsYssjoqSwswnTVQJDnLjRJDLaf\",\n \"expectedTokenAmount\": 24.366471734892787,\n \"token\": \"usdt\",\n \"currencyInLocal\": \"TRY\",\n \"chain\": \"tron\",\n \"qrCode\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAAEsAQAAAABRBrP...\"\n}\n\nWhat to do with the response
\nShow the address and the QR to the user.
\nqrCode is a PNG Data URL; you can display it directly in HTML:img src=\"data:image/png;base64,...\" alt=\"Deposit QR\"\n\nDisplay the expectedTokenAmount so the user knows how much token to send for the chosen local amount.
Keep externalTxId on your side; it will also appear in the callback.
Idempotency / duplicates
\nexternalTxId must be unique.
If you send the same externalTxId again, we may reject with 400 Bad Request.
After funds are detected and confirmed on-chain, we POST to your callback URL.
\nYour endpointPOST https:///fluxpay/deposit/callback (example)
Headers (examples)
\nContent-Type: application/json
X-Request-Id:
X-Signature: (optional, if signing is enabled)
{\n \"status\": \"CONFIRMED\",\n \"txId\": \"b3b4c7e21f90a6a5f0d2e9c18a4f6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a3\",\n \"receivedTokenAmount\": 24.370000,\n \"receivedFiatAmount\": 1000.00,\n \"currency\": \"TRY\",\n \"token\": \"usdt\",\n \"chain\": \"tron\",\n \"externalTxId\": \"ext-tx-0024234\",\n \"depositAddress\": \"TJXkjYHDsYssjoqSwswnTVQJDnLjRJDLaf\",\n \"timestamp\": \"2025-08-23T10:49:02Z\"\n}\n\nStatuses
\nCONFIRMED → final successAlways use GET /api/public/supported-currencies to populate your currency selector. Send only token and chain from that list.
The deposit address is unique per request—do not reuse it across users.
\nShow the QR code and expectedTokenAmount exactly as returned.
\nEnsure your requests come from allowlisted IPs and include the x-api-key header.
This endpoint supports only the Ethereum (ETH) chain and the ETH native token, and operates identically to /api/deposit/request in logic and behavior.
Discover assets – Call GET /api/public/supported-currencies to get all valid token + chain pairs.
User selects a currency in your UI – From the selected row, take the token and chain values (do not send label).
Create a withdrawal – Call POST /api/withdraw/request with the body below.
Immediate response – We return a JSON object with a server id, your externalTxId, and the initial status.
Callback (webhook) – When the withdrawal finishes completed, we send a POST to your callback URL with a final status payload.
\nEndpointGET {{baseUrl}}/api/public/supported-currencies
Purpose
\nReturns every valid combination of token and chain you can use when creating a withdrawal. label is display-only for your UI.
200 – Example
\n[\n{ \"token\": \"usdt\", \"label\": \"USDT (TRC20)\", \"chain\": \"tron\" },\n{ \"token\": \"tron\", \"label\": \"TRX\", \"chain\": \"tron\" },\n{ \"token\": \"usdt\", \"label\": \"USDT (ERC20)\", \"chain\": \"eth\" },\n{ \"token\": \"eth\", \"label\": \"ETHEREUM\", \"chain\": \"eth\" },\n{ \"token\": \"btc\", \"label\": \"BITCOIN\", \"chain\": \"btc\" },\n{ \"token\": \"busd\", \"label\": \"BUSD (BEP20)\", \"chain\": \"bsc\" },\n{ \"token\": \"bnb\", \"label\": \"BNB\", \"chain\": \"bsc\" },\n{ \"token\": \"doge\", \"label\": \"DOGE\", \"chain\": \"doge\" },\n{ \"token\": \"ada\", \"label\": \"ADA\", \"chain\": \"ada\" },\n{ \"token\": \"sol\", \"label\": \"SOLANA\", \"chain\": \"solana\" },\n{ \"token\": \"usdc\", \"label\": \"USDC (SOLANA)\", \"chain\": \"solana\" },\n{ \"token\": \"xlm\", \"label\": \"XLM\", \"chain\": \"xlm\" },\n{ \"token\": \"xrp\", \"label\": \"XRP\", \"chain\": \"xrp\" }\n]\n\nEndpointPOST {{baseUrl}}/api/withdraw/request
Content-Type: application/json
x-api-key: {{apiKey}}
Take token and chain directly from the available currencies list row the user selected.
{\n\"externalTxId\": \"ext-tx-232323\",\n\"token\": \"usdt\",\n\"currencyInLocal\": \"TRY\",\n\"chain\": \"tron\",\n\"toAddress\": \"TX7y4vtDa7QFeR2z4SEtC5j5dkYH3TQoUF\",\n\"amountInLocalCurrency\": 20\n}\n\nField Details
\nexternalTxId (string, required) – Your unique reference for idempotency & reconciliation.
token (string, required) – From discovery (usdt, eth, btc, …).
chain (string, required) – From discovery (tron, eth, bsc, …).
currencyInLocal (string, required) – ISO-4217 (e.g., TRY, USD, EUR).
amountInLocalCurrency (number, required) – Amount in the local currency above.
toAddress (string, required) – Destination address for the selected chain.
destinationTag (string, optional) – Required for chains that need it (e.g., xrp, xlm). Omit for chains that don’t.
202 Accepted – Success Response
\n{\n \"transactionId\": 21,\n \"externalTxId\": \"ext-tx-23312323\",\n \"status\": \"PENDING\",\n \"message\": \"Withdraw request accepted for processing.\"\n}\n\nAfter the withdrawal is processed on our side (success), we POST a callback to your configured URL.
\nYour endpointPOST https:///fluxpay/withdraw/callback (example)
Headers (examples)
\nContent-Type: application/jsonCallback body (example)
\n{\n\"amount\":1.7548477669562166,\n\"status\":\"COMPLETED\",\n\"blockchainTxId\":\"d991ad7a5ee5e1104b7dbf069ec175b4383b8781a173da6a75ef3df938c13411\",\n\"externalTxId\":\"ext-tx-232323\",\n\"token\":\"TRON\",\n\"timestamp\":\"2025-06-10T13:27:42.660203200\",\n\"toAddress\":\"TX7y4vtDa7QFeR2z4SEtC5j5dkYH3TQoUF\"\n}\n\nStatus values
\nCOMPLETED → FAILEDYou can tweak any sample field names/values (fees, timestamps, retry policy, signature scheme) to match your actual implementation.
\n","urlObject":{"path":["api","withdraw","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"dca0c05c-7258-4690-b3c9-c025585cd960","name":"202 Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"externalTxId\": \"ext-tx-2321311323\",\r\n \"token\": \"tron\",\r\n \"currencyInLocal\": \"TRY\",\r\n \"chain\": \"tron\",\r\n \"toAddress\": \"TX7y4vtDa7QFeR2z4SEtC5j5dkYH3TQoUF\",\r\n \"amountInLocalCurrency\": 20\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/withdraw/request"},"status":"Accepted","code":202,"_postman_previewlanguage":null,"header":[{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 28 Aug 2025 07:08:20 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": 22,\n \"externalTxId\": \"ext-tx-2321311323\",\n \"status\": \"PENDING\",\n \"message\": \"Withdraw request accepted for processing.\"\n}"},{"id":"8d0bd77d-1f16-4676-83a0-0dd1c10ae906","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"externalTxId\": \"ext-tx-232131323\",\r\n \"token\": \"tron\",\r\n \"currencyInLocal\": \"TRY\",\r\n \"chain\": \"tron\",\r\n \"toAddress\": \"TX7y4vtDa7QFeR2z4SEtC5j5dkYH3TQoUF\",\r\n \"amountInLocalCurrency\": 20\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/withdraw/request"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json;charset=ISO-8859-1"},{"key":"Content-Length","value":"28"},{"key":"Date","value":"Thu, 28 Aug 2025 07:06:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid API key\"\n}"},{"id":"04b0a626-53d7-45a1-acb1-6e1e32660742","name":"400 Bad Request - externalTxId duplication","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"externalTxId\": \"ext-tx-2321311323\",\r\n \"token\": \"usdt\",\r\n \"currencyInLocal\": \"TRY\",\r\n \"chain\": \"tron\",\r\n \"toAddress\": \"TX7y4vtDa7QFeR2z4SEtC5j5dkYH3TQoUF\",\r\n \"amountInLocalCurrency\": 2000\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/withdraw/request"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 28 Aug 2025 07:09:12 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILED\",\n \"message\": \"Bu externalTxId ile zaten bir işlem var.\"\n}"},{"id":"8cfab846-8f86-4211-b0f4-64148247d8bd","name":"400 Bad Request - Insufficient Funds","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"externalTxId\": \"ext-tx-23211311323\",\r\n \"token\": \"usdt\",\r\n \"currencyInLocal\": \"TRY\",\r\n \"chain\": \"tron\",\r\n \"toAddress\": \"TX7y4vtDa7QFeR2z4SEtC5j5dkYH3TQoUF\",\r\n \"amountInLocalCurrency\": 2000\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/withdraw/request"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 28 Aug 2025 07:10:05 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILED\",\n \"message\": \"Yetersiz bakiye: usdt\"\n}"},{"id":"b6db08c7-574b-46c3-a10e-6e018d544fd4","name":"400 Bad Request - Minimum Withdraw Amount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"externalTxId\": \"ext-tx-23211311323\",\r\n \"token\": \"usdt\",\r\n \"currencyInLocal\": \"TRY\",\r\n \"chain\": \"tron\",\r\n \"toAddress\": \"TX7y4vtDa7QFeR2z4SEtC5j5dkYH3TQoUF\",\r\n \"amountInLocalCurrency\": 999\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/withdraw/request"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 28 Aug 2025 07:18:15 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILED\",\n \"message\": \"Minimum çekilebilir tutar: 1000.0 TRY\"\n}"}],"_postman_id":"4398eeb5-ac1e-478e-a396-3395b0cd59f8"},{"name":"createTestWithdrawRequest","id":"86e45bbd-f7f9-4b2d-a337-845d966a896f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"externalTxId\": \"ext-tx-23211311323\",\r\n \"token\": \"usdt\",\r\n \"currencyInLocal\": \"TRY\",\r\n \"chain\": \"tron\",\r\n \"toAddress\": \"TX7y4vtDa7QFeR2z4SEtC5j5dkYH3TQoUF\",\r\n \"amountInLocalCurrency\": 999\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/test/withdraw/request","description":"This endpoint supports only the Ethereum (ETH) chain and the ETH native token, and operates identically to /api/withdraw/request in logic and behavior.