Here you can find the workflow and detailed explanation of API requests that let you process crypto payments on your platform.
\nDevcode/Payments IQ: https://payments-iq.com
\nPraxis: https://praxis.tech
\nAnd others like Corefy, FXbo and etc.
\nIf you have any questions or you want to test our solution, feel free to reach out to us via support@heropayments.io
\nTo use Heropayments API, you should do the following:
\nSign up at https://app.heropayments.io/ or at my.heropayments.io;
\nImport our collection of API methods in Postman;
\nInsert API keys in Postman;
\nSend a request.
\nDO NOT SHARE YOUR API/SECRET KEY WITH ANY 3RD PARTIES!
\nA user wants to top up the account:
\nUI - Add a \"top up with crypto\" method to your platform;
\nUI - Ask your user to choose a cryptocurrency for the deposit and specify the amount to create a deposit transaction in the user's account currency (transaction amount is optional);
\nAPI - To get estimated deposit amount for the selected cryptocurrency use GET \"Get estimated price\" and to get minimum deposit amount use GET \"Minimum payment amount (V2)';
\nUI - Display the minimum deposit amount to your user and inform them that a lower amount won't be processed;
\nAPI - To create the transaction for deposit and to generate a deposit address call the POST \"Create a deposit (V2)\" / \"Create a deposit (Custody)\";
\nUI - Show the generated deposit address to your user and ask to send the payment there. Once Heropayments accepts the deposit, it will be automatically converted into your balance currency and credited to your Merchant's account in our system.
\nAPI - Get the transaction status either via our callbacks or manually via GET \"Payment status check by id (V2)\" / \"Payment status check by id (Custody)\";
\nAll deposits are accumulated on your Merchant's account USDT wallet in our system. Call GET \"Get balance\" method to check the balance. You can get a settlement upon the request.
\nOur multiple deposit processing feature increases the conversion rate of deposits. It will let your users pay twice or more to the same deposit address without visiting the cashier.
\nAutomated mistaken deposits processing will allow us to accept deposits if users mistakenly send a currency different from the one specified in the invoice.
\nFirst, you can view the available balance using GET “Get balance (V2)” / \"Get balance (Custody)\".
\nTo create a withdrawal, use POST “Create a withdrawal (V2)\" / \"Create a withdrawal (Custody)\" request method. Specify the address, currency and amount for the withdrawal.
\nYou can monitor transaction status via our callbacks or manually, using GET \"Payment status check by id (V2)\" / \"Payment status check by id (Custody)\".
\nUI - Add the withdrawal with crypto option to your platform;
\nUI - Ask your user to choose a cryptocurrency for withdrawal;
\nAPI - Get the estimated amount for the selected currency by using POST \"Get estimated price\" and minimum withdrawal amount by using \"Minimum payment amount (V2)\";
\nUI - Display the minimum withdrawal amount to your user and make clear that a lower amount won't be processed;
\nUI - Ask the user to specify a crypto wallet address to receive a withdrawal;
\nAPI - Call POST \"Create a withdrawal (V2)\" / \"Create a withdrawal (Custody)\";
\nAPI - Get the transaction status via our callbacks or manually, by calling GET \"Payment status check by id (V2)\" / \"Payment status check by id (Custody)\" method to receive actual information about the withdrawal request.
\nDaily withdrawal limits:
\nTo elaborate on this, withdrawal limits are made to prevent situations when a merchant's account might accidentally run out of funds or overpay to a particular user.
\nWe have 2 types of daily limits:
\nMerchant withdrawal limit – for the entire merchant account per day
\nCustomer withdrawal limit – for each customerID per day
\nTo set up the limits, reach us via partners@heropayments.io or contact your personal account manager.
\nIn order to sign API requests, you will have to use your API Secret (which can be found in your admin panel - https://app.heropayments.io/api or https://my.heropayments.io/settings/api-keys) to calculate the request signature using the HMAC-SHA512 algorithm.
\nYou have to pass the request body as the data parameter and your API Secret as secretKey parameter. After calculating the signature, you have to attach it to the x-api-sign header.
\nFor all requests with body - you should sign body and specify it to x-api-sign header.
\nFor all GET requests - you should sign query string without question mark(?). For example:https://api.heropayments.io/v2/method?foo=bar should be signed string foo=bar
If a request doesn't have a query string, you should sign an empty string:
\nyourSigningFunction('')
Then specify it to x-api-sign header.
\nPLEASE NOTE
\nTo make sure you calculate the correct signature, you have to normalize the JSON data:
\nit should not contain any spaces or newlines in it.
\nit should not have any zero-padded numbers (from both sides) unless they're quoted strings (e.g. 001.10 is invalid, \"001.10\" is valid)
\nEasiest way to do this automatically with Javascript:JSON.stringify(JSON.parse(yourJsonString))
You can check if the created signature is valid or not via our signature validation tool - https://codepen.io/ethan-reynolds-9823/full/jEOVRbV
\nPostman pre-request script (V2):
\nconst crypto = require('crypto-js');\nlet payload = '';\nconst secret = pm.environment.has('api-secret')\n ? pm.environment.get('api-secret')\n : pm.variables.has('api-secret')\n ? pm.variables.get('api-secret')\n : pm.globals.has('api-secret')\n ? pm.globals.get('api-secret')\n : pm.collectionVariables.has('api-secret')\n ? pm.collectionVariables.get('api-secret')\n : console.error(new Error('api-secret is missing'));\ntry {\n switch (pm.request.method) {\n case 'POST': \n payload = JSON.stringify(JSON.parse(pm.request.body.toString()));\n break;\n case 'GET':\n payload = pm.request.url.query.toString();\n break;\n }\n} catch {\n console.error(new Error('Cant decode JSON body'))\n}\nconsole.log('payload', payload);\nconst sign = crypto.HmacSHA512(payload, secret).toString();\npm.request.headers.upsert({\n key: 'x-api-sign',\n value: sign,\n});\n\nPostman pre-request script (Custody):
\nconst crypto = require('crypto-js');\nlet payload = '';\nconst secret = pm.environment.has('api-secret-custody')\n? pm.environment.get('api-secret-custody')\n: pm.variables.has('api-secret-custody')\n? pm.variables.get('api-secret-custody')\n: pm.globals.has('api-secret-custody')\n? pm.globals.get('api-secret-custody')\n: pm.collectionVariables.has('api-secret-custody')\n? pm.collectionVariables.get('api-secret-custody')\n: console.error(new Error('api-secret-custody is missing'));\ntry {\npayload = JSON.stringify(JSON.parse(pm.request.body.toString()));\n} catch {\nconsole.error(new Error('Cant decode JSON body'))\n}\nconst sign = crypto.HmacSHA512(payload, secret).toString();\n// console.log(secret, sign);\npm.request.headers.upsert({\nkey: 'x-api-sign',\nvalue: sign,\n});\n\nAn example in node.js (backend):
\nimport crypto from 'crypto';\nfunction calculateSignature (data: string | Buffer, secretKey: string | Buffer): string {\n return crypto\n .createHmac('SHA512', secretKey.toString())\n .update(data.toString())\n .digest('hex');\n}\n\nAn example in C#:
\nusing System;\nusing System.Security.Cryptography;\nusing System.Text;\npublic class HmacHelper\n{\n public static string CalculateSignature(object data, object secretKey)\n {\n byte[] dataBytes;\n byte[] secretKeyBytes;\n if (data is string dataString)\n {\n dataBytes = Encoding.UTF8.GetBytes(dataString);\n }\n else if (data is byte[] dataBuffer)\n {\n dataBytes = dataBuffer;\n }\n else\n {\n throw new ArgumentException(\"Data must be a string or byte array\");\n }\n if (secretKey is string secretKeyString)\n {\n secretKeyBytes = Encoding.UTF8.GetBytes(secretKeyString);\n }\n else if (secretKey is byte[] secretKeyBuffer)\n {\n secretKeyBytes = secretKeyBuffer;\n }\n else\n {\n throw new ArgumentException(\"Secret key must be a string or byte array\");\n }\n using (var hmac = new HMACSHA512(secretKeyBytes))\n {\n var hashBytes = hmac.ComputeHash(dataBytes);\n return BitConverter.ToString(hashBytes).Replace(\"-\", \"\").ToLower();\n }\n }\n public static void testStrings()\n {\n string data = \"example data\";\n string secretKey = \"your-secret-key\";\n string signature = CalculateSignature(data, secretKey);\n Console.WriteLine(\"Signature: \" + signature);\n }\n public static void testBytes()\n {\n byte[] data = System.Text.Encoding.UTF8.GetBytes(\"example data\"); // Data in buffer form\n byte[] secretKey = System.Text.Encoding.UTF8.GetBytes(\"your-secret-key\"); // Key as a buffer\n string signature = CalculateSignature(data, secretKey);\n Console.WriteLine(\"Signature: \" + signature);\n }\n public static void Main()\n {\n testStrings();\n testBytes();\n }\n}\n\nAn example in PHP:
\n $apiKey = 'YOUR_KEY';\n $apiSecret = 'YOUR_SECRET';\n $apiUrl = 'https://api.heropayments.io/v2/payments';\n $message = json_encode(\n array(\n 'payCurrency' => 'trx',\n 'priceCurrency' => 'usd',\n 'priceAmount' => '1000',\n 'customerId' => '123',\n 'customerEmail' => 'test@test.com',\n 'externalOrderId' => '100500',\n 'callbackUrl' => 'https://example.com/callback?orderId=100500'\n ),\n JSON_UNESCAPED_SLASHES\n );\n $sign = hash_hmac('sha512', $message, $apiSecret);\n $requestHeaders = [\n 'x-api-key:' . $apiKey,\n 'x-api-sign:' . $sign,\n 'Content-type: application/json'\n ];\n $ch = curl_init($apiUrl);\n curl_setopt($ch, CURLOPT_POST, 1);\n curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n curl_setopt($ch, CURLOPT_POSTFIELDS, $message);\n curl_setopt($ch, CURLOPT_HTTPHEADER, $requestHeaders);\n $response = curl_exec($ch);\n curl_close($ch);\n var_dump($response);\n\nAn example in Python:
\n #Python 3.8\nimport requests\nimport json\nimport hashlib\nimport hmac\nurl = \"https://api.heropayments.io/v2/payments\"\ndef generate_signature(data):\n key = \"YOUR_SECRET\" \n key_bytes= key.encode() \n data_bytes = data.encode()\n return hmac.new(key_bytes, data_bytes, hashlib.sha512).hexdigest()\npayload = {\n \"payCurrency\":\"trx\",\n \"priceCurrency\":\"usd\",\n \"priceAmount\":1000,\n \"customerId\":\"123\",\n \"externalOrderId\":\"100500\",\n \"customerEmail\":\"test@test.com\",\n \"callbackUrl\":\"https://example.com/callback?orderId=100500\",\n \"fiat\": True,\n}\npayload = json.dumps(payload, separators=(',', ':'))\nheaders = {\n 'x-api-key': 'YOUR_KEY',\n 'Content-Type': 'application/json',\n 'x-api-sign': generate_signature(payload)\n}\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nAn example in browser:
\nimport hmacSHA512 from 'crypto-js/hmac-sha512';\nfunction calculateSignature (data: string | Buffer, secretKey: string | Buffer): string {\n return hmacSHA512(data.toString(), secretKey.toString());\n}Also you can use Postman pre-request script:\n\nCallbacks are used for notifications when transaction status is changed. To use them, you should complete the following steps:
\nGet the secret key in \"API\" section at the admin panel;
\nWhen you call POST \"Create a deposit (V2)\" / \"Create a deposit (Custody)\" or POST \"Сreate a withdrawal (V2)\" / \"Create a withdrawal (Custody)\" request, insert your URL address in \"callbackUrl\" field to get notifications.
\nYou will receive all the parameters at the URL address you specified in (2) by POST request. The POST request will contain x-api-sign parameter in the header. The body of the request is similar to GET “Payment status check by id (V2)” / \"Payment status check by id (Custody)\" response body, but not identical;
\nConvert the response body to string using JSON.stringify;
\nSign a string with a secret key with HMAC-SHA512 algorithm;
\nCompare the signed string from the previous step with the x-api-sign stored in the header of the callback request. If these strings are identical, the system works properly. Otherwise, contact us via support@heropayments.io to solve the problem.
\n\"id\": \"f5529a76-cb68-4d19-a97b-12dcd6712c02\", // Heropayments payment ID.\n \"fiat\": true, // parameter to specify for priceCurrency. True is set by default. Pass false to create a transaction with crypto estimation.\n \"status\": \"finished\", // status of the transaction.\n \"feeUSDT\": 0.02694825, // Heropayments processing fee (clientAmountUsdt * feePercent)\n\"invoice\": {\n \"id\": \"9852d8c1-fca6-45d8-aa55-99e0050c2d94\", // invoice ID, not recommended to use it as payment identificator, as it does not appear in the report.\n \"orderId\": \"1454445333244115\", // merchant's custom order ID.\n \"customerId\": \"123\", // ID of the customer.\n \"priceAmount\": 100, // amount specified by the user for the deposit in priceCurrency. The estimated amount to complete the payment, is not equal to the sent amount.\n \"priceCurrency\": \"usd\" // user's account currency: fiat or cryptocurrency (USD, EUR, BTC,DOGE etc.)\n },\n \"payHash\": \"0x4fee71ad6617f18cfd0e75a9a349496f8bab04d4bbab44944a47376f40ead6a\", // transaction hash to the deposit address.\n \"payRate\": 598.85, // payCurrency to outcomeCurrency ratio.\n \"payExtra\": null, // additional Id which is necessary for identifying a recipient of the transaction (memo, destination tag). Obligatory for deposits in XRP, XLM, HBAR.\n \"sequence\": \"original\", // as soon as each payment has to have its own unique externalOrderId, we add an additional field \"sequence\" to differentiate the subsequent payments.\nUse case: after finishing the first payment, the customer saves the payAddress and sends the funds again to this address without creating an invoice on the site.\nExample for the first payment:\nexternalOrderID: 1254435345456456\nsequence: original\nExample for the second and further payments:\nexternalOrderID: 1254435345456456\nsequence (2nd payment): 4fb7defa35a056ecc64fc74ea97ef90f (new unique ID)\nsequence (3rd payment: 4fb7d453566545623ав2343455(new unique ID)\netc.\n \"createdAt\": \"2025-05-02T19:56:13.000Z\", // time, when the transaction was created.\n \"payAmount\": 0.1678591, // expected amount to pay by the user in crypto (payCurrency) to finish the transaction.\n \"priceRate\": 0.9996, // priceCurrency to outcomeCurrency ratio.\n “userNotes” : null, // technical field, not used.\n \"feePercent\": 0.5, // Heropayments processing fee (%).\n \"networkFee\": 0,5, // network fee deducted for processing the blockchain transaction.\n \"paidAmount\": 0.009, // amount that was actually sent in crypto (payCurrency) in the transaction.\n \"payAddress\": \"0x2d7e23d8f9e04110d1c6d255b40841a8585d6662\", // deposit address for crypto assets, used to process the deposit.\n \"callbackUrl\": \"https://example.com/callback\", // HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update.\n \"outcomeHash\": \"0x4fa6f8ca917de24ddf289a997de597657f48b1c9a2f5ffae96847e8e6c36595\", // transaction hash to the merchant’s balance wallet.\n \"payCurrency\": \"bnbbsc\", // cryptocurrency sent by the user to finish the deposit\n \"payHashLink\": \"https://bscscan.com/tx/0x4fee71ad664f18cfffd0e75a9a3494696f8bab0d4bbab44944a4376f40ea56a\", // link to the transaction hash.\n \"clientAmount\": 5.39, // fiat equivalent of clientAmountUsdt in priceCurrency. Shows the amount to be credited to user’s account.
\n \"payinSenders\": [\n \"0x3b3cfe3336b6accf2044274cf3c4825c4b644cb\" // customer’s wallet, used to process the deposit.\n ],\n \"customerEmail\": \"TestEmail.com\", // user’s email address (not required).\n \"outcomeAmount\": 4.86270175, // amount credited to the merchant’s wallet.\n \"outcomeAddress\": \"0x8a466fc4c95dd97d51fa5532890dea7fff0cfbf\",\n \"externalOrderId\": \"1454445333244115\", // merchant's custom order ID\n \"outcomeCurrency\": \"usdt20\", // merchant’s balance currency.\n \"outcomeHashLink\": \"https://etherscan.io/token/0xdac17f958d2ee523a22006994597c13d831ec7?a=0x4fa6f8ca917de24ddf28cc9a997de597657f8b1c9a2f5ffae96847e84e6c36595\", // transaction hash link after the exchange to merchant’s wallet.\n \"transactionType\": \"deposit\", // always deposit or withdrawal\n \"clientAmountUsdt\": 5.38965 // deposit amount received from the user and converted to USDT. Calculated as “merchantAmountUsdt” + network fee + processing fee.\n \"merchantAmountUsdt\": 4.86270175 // amount credited to Merchant’s wallet in USDT. Calculated as ClienttAmountUsdt” - network fee - processing fee.\n\nV2 withdrawal Callback
\n \"id\": \"536d0fcf-beb3-4b6b-b752-4ec5b16e02e8\", // Heropayments payment ID.\n \"fiat\": true, // // parameter to specify priceCurrency. True is set by default. Pass false to create a transaction with crypto estimation, if the user's account is in crypto.\n \"status\": \"finished\", // // status of the transaction.\n \"feeUSDT\": 0.03933199, // Heropayments processing fee (clientAmountUsdt * feePercent).\n \"invoice\": {\n \"id\": \"b4d98885-f83e-42d9-a5b2-fec6f868f5cb\", // invoice ID, not recommended to use it as payment identificator, as it does not appear in the report.\n \"orderId\": null, // always null\n \"customerId\": \"12312\", // ID of the customer.\n \"priceAmount\": 600, // amount specified by the user for the withdrawal in priceCurrency. The estimated amount to complete the payment, is not equal to the sent sum.\n \"priceCurrency\": \"rub\" // user's account currency: fiat or cryptocurrency (ex. USD, EUR, BTC,DOGE etc.)\n \"payHash\": \"0x0f248ffd2874c0def2b15141eb1409603a9ed24a870c948d13644402f84fd\", // transaction hash from the merchant's balance address to an exchange address.\n \"payRate\": 1, // payCurrency to outcomeCurrency ratio.\n \"payExtra\": null, // additional Id which is necessary for identifying a recipient of the transaction. Also known as additional address, memo or destination tag. Users must enter it while withdrawing XRP, BNB, XLM and some other currencies\n \"sequence\": \"original\", //used for deposits only, for withdrawals remains \"original\".\n \"createdAt\": \"2025-03-06T10:57:22.000Z\", // time, when the transaction was created.\n \"payAmount\": 6.85714285, // the amount that must be deducted from the merchant's account to process a withdrawal.\n \"priceRate\": 0.01086, // priceCurrency to outcomeCurrency ratio.\n \"userNotes\": null, // technical field, not used.\n \"feePercent\": 0.6, // Heropayments processing fee (%).\n \"networkFee\": 0.3, // network fee deducted for processing the blockchain transaction.\n \"paidAmount\": 6.85714285, // the amount deducted from the balance to process the payment.\n \"callbackUrl\": \"https://webhook.site/07e09722-fc19-4d0d-b81f-f36a8c65850\", // HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update.\n \"outcomeHash\": \"0x98a839528e39a1d4c1472fcc878df6aa62f41ca5bf9ffd902035b9402cfe8f\", // transaction hash to the user's wallet\n \"payCurrency\": \"usdtbsc\", // merchant's balance currency.\n \"payHashLink\": \"https://bscscan.com/tx/0x0f248ffd2874c0d2b15141eb141b09603a9ed624a870c948d13644402f84fd\", // transaction hash from the merchant's balance address to an exchange address.\n \"clientAmount\": 600, // equivalent of priceAmount in priceCurrency. This amount that user should receive for a withdrawal.\n \"customerEmail\": \"test@test.com\", // user's email address (not required).\n \"outcomeAmount\": 6.516, // the amount that a user received for a withdrawal\n \"outcomeAddress\": \"0x3b3cfe3336b6accf2044274cf3c5c25c4b64cb\", // user's address to receive the withdrawal.\n \"outcomeExtraId\": null, // the same as payExtra.\n \"externalOrderId\": \"112434321\", // merchant's custom order ID.\n \"outcomeCurrency\": \"usdtbsc\", // a currency that the user chose for the withdrawal.\n \"outcomeHashLink\": \"https://bscscan.com/tx/0x98a839528e39a4c1472fcc878df6aa62f41ca5bb9f9ffd902035b9402cfe8f\", // transaction hash link to the user's wallet.\n \"transactionType\": \"withdrawal\", // always deposit or withdrawal.\n \"clientAmountUsdt\": 6.51781086, // USDT equivalent of a withdrawal amount sent to the user. Calculated as \"merchantAmountUsdt\" - network fee - processing fee.\n \"merchantAmountUsdt\": 6.85714285 // the amount deducted from the balance to process the payment. Calculated as \"ClienttAmountUsdt\" + network fee + processing fee.\n\nCustody deposit Callback
\n\"id\": \"f3748917-d4ae-4dae-bec1-c00e269be990\", // Heropayments payment ID.\n \"hash\": \"0xc81b15173d536f5063ec4c11cfd37aa5cfbfd668ac2433d175efea100bfd25234\", // deposit hash\n \"amount\": \"4\", // deposited amount.\n \"status\": \"finished\", // status of the transaction.\n \"address\": \"0xfc9ca35f6296cadfc5f925145acd55abfd0eafae8\", // deposit address for crypto assets.\n \"comment\": null, // additional information about the deposit.\n \"currency\": \"usdtbsc\", // deposited currency.\n \"hashLink\": null,\n \"sequence\": \"original\", // helps to differentiate between the subsequent payments. Please read multiple deposit processing.\n \"subEmail\": null, // if a payment was created by a subuser of the main account, the field reflects the name of the subaccount.\n \"createdAt\": \"2025-03-13T14:16:53.315Z\", // time, when the deposit was created.\n \"feeAmount\": \"0.02\", // Heropayments processing fee in the Currency equivalent.\n \"updatedAt\": \"2025-03-13T14:21:22.163Z\", // time, when the deposit was updated.\n \"customerId\": \"new_test_user\",\n \"feePercent\": 0.5, // Heropayments processing fee (%).\n \"networkFee\": \"0.3\", // network fee deducted for processing the blockchain transaction. Estimated in a payment currency equivalent\n \"callbackUrl\": \"https://webhook.site/07e09722-fc19-4d0d-b81f-f5236a8c65850\", // HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries.\n \"addressExtra\": null, // additional Id which is necessary for identifying a recipient of the transaction (memo, destination tag). Obligatory for deposits in XRP, XLM, HBAR.\n \"clientAmount\": \"4\", // amount of crypto received from a user to a created deposit address.\n \"confirmations\": 23, // number of confirmations on the blockchain. We need to wait until the payment gets at least several confirmations to process it.\n \"merchantAmount\": \"3.68\", //amount credited to Merchant's wallet in Currency\n \"externalOrderId\": \"mercha56564554n2t_44o5rder_id_123123\", // merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction.\n \"transactionType\": \"deposit\" // always deposit or withdrawal.\n\nWe strongly recommend you to back up callback services by using GET \"Payment status check by id (V2)” / \"Payment status check by id (Custody)\" to receive the same info about payments as you get from the callback notification.
\nWe highly recommend setting static callBackUrls both for deposit and withdrawals. Using static callBackUrls will facilitate the process of changing callback URLs if a need arises.
\nExample of static callBackUrls (recommended flow)
\nDeposit: https://m54543qin7.com/deposit/hero_payments (for all deposit transactions one callBackUrl)
\nWithdrawal: https://m54543qin7.com/withdrawal/hero_payments (for all withdrawal transactions one callBackUrl)
\nExample of dynamic callBackUrls (not recommended flow)
\nDeposit:
https://m54543qin7.com/deposit/hero_payments/payment_1
https://m54543qin7.com/deposit/hero_payments/payment_2
https://m54543qin7.com/deposit/hero_payments/payment_3
etc.
Withdrawal:
https://m54543qin7.com/withdwaral/hero_payments/payment_1
https://m54543qin7.com/withdwaral/hero_payments/payment_2
https://m54543qin7.com/withdwaral/hero_payments/payment_3
etc.
The transaction's status describes what is happening to the funds at any given moment and their current state.
\nFor the detailed description of the statuses, please refer to the GET \"Payment status check by id (V2)” method.
\nIn progress:
\nwaiting
\nconfirming
\nexchanging
\nhold
\nFailed or unsuccessful (suspend the transaction on your end):
\nfailed
\nrefunded
\nexpired
\nSuccessful (complete the deposit on your end by updating the balances, etc.):
\nsending
\nfinished
\nIn progress:
\nwaiting
\nconfirming
\nexchanging
\nhold
\nsending
\nFailed or unsuccessful (suspend the transaction on your end):
\nfailed
\nrefunded
\nSuccess (complete the withdrawal on your end by updating the balances, etc.):
\nHow to implement user balance top-up at the Confirming status?
\nIn the confirming callback, we send the value of the paidAmount field — this is the actual amount of cryptocurrency the user transferred to the deposit address.
1) Balance currency: USD — payment in stablecoin
If the user’s balance currency is USD and they pay in a stablecoin (USDT TRC20, USDT ERC20, etc.), you can use the paidAmount value and credit the equivalent amount in fiat.
2) Balance currency is not USD
To estimate how much fiat should be credited to the user, we recommend using the endpoint:
https://api.heropayments.io/v2/rate
Sometimes a transaction does not reach the finished status and, after confirming, receives the failed status (meaning the funds never reached us). In this case, the user’s balance would be credited even though the funds were not actually received.
finished status?The client may:
\nSet a network fee that is too low, causing the transaction to fail because miners do not include it in a block (relevant for Ethereum).
\nSend a transaction to the network and then cancel it immediately (BTC, ETH). Some wallets, such as Trezor, allow this.
\nSend a transaction with a low network fee, cancel it, and then resend it to the same deposit address with a higher fee. In this case, we will mark the first transaction as failed and create a new one, processing the payment as a multi-deposit.
\nBefore using the confirming status to credit user balances, please contact our team for additional information.
\nFor the detailed description of the statuses, please refer to the GET \"Get custody payment status” method.
\nIn progress:
\nnew
\npending
\nprocessing
\nhold
\nFailed or unsuccessful (suspend the transaction on your end):
\nfailed
\nexpired
\nSuccess (complete the withdrawal on your end by updating the balances, etc.):
\nIn progress:
\npending
\nprocessing
\nhold
\nFailed or unsuccessful (suspend the transaction on your end):
\nfailed
\nrefunded
\nSuccess (complete the withdrawal on your end by updating the balances, etc.):
\nIn case a customer deposits to the same payAddress twice or more, it will still be processed.
\nEach customer’s transfer is a new payment. As soon as each payment has to have its own unique externalOrderId, we add a new field \"sequence\" to differentiate the subsequent payments.
\nThe initial payment receives an original externalOrderId and the \"sequence\" field remains unchanged.
\nFor the subsequent payments, \"sequence\" field gets a value.
\nExample for the first payment:
\nexternalOrderID: 1254435345456456
\nsequence: original
\nExample for the second and further payments:
\nexternalOrderID: 1254435345456456
\nsequence: 4fb7defa35a056ecc64fc74ea97ef90f (new unique ID)
\nA customer may save the deposit address on their side and send the funds without going through the process all over again.
\nIn cases of multiple deposits, callbacks are sent to the callbackUrl of the initial payment. Our support may also notify you in case of multiple deposits.
\nDeposit status:
\nA new generated deposit-transaction remains in the status “waiting” for 4 hours (TTL) after the creation. If the transaction is not completed within this period, it receives status “expired”. If there is no new empty “waiting” transaction, we will generate a multi-deposit for an incoming payment.
\nAction required: adjust your system to field sequence to handle the callbacks of multiple deposits.
\nFlow description:
\n1. A user creates a deposit request in USDT (TRC20) (payCurrency: usdttrc20), but sends TRX instead (payCurrency: trx).
\n2. We will automatically detect the incorrect currency and credit the funds to your balance.
\nSince we process the deposit for the user in priceCurrency, we will send a callback to the same URL with the same externalOrderId and the field sequence: original, but with the updated payCurrency: trx.
\npayCurrency: usdttrc20
externalOrderId: order_id123
sequence: original
callbackUrl: webhook.url/merchant123
payCurrency: trx
externalOrderId: order_id123
sequence: original
callbackUrl: webhook.url/merchant123
Important notes:
\nThe payCurrency of the newly processed incorrect deposit contains the actual deposited currency (as shown above).
\nThe externalOrderId of the processed deposit is taken from the original payment.
\nWe support processing incorrect deposits only within the same blockchain network.
\nThe feature does not work on the Solana blockchain.
\nMethods to generate a deposit transaction:
\nV2 flow: v2/payments, v2/payments-address
Custody flow: custody/deposit
We generate a deposit address for each unique customerId. The next time you create a deposit, your customer will receive the same deposit address.
\nIf a customer sends a deposit without creating an order on your side, it will be considered as a multiple deposit.
\nV2:
\nhttps://docs.google.com/spreadsheets/d/16R_DIBU_3TIwKG7j6e2Iq6smyWXvSK5kWRYPpyPwym4/edit?gid=0#gid=0
\nCustody:
\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Recommended integration flow","slug":"recommended-integration-flow"},{"content":"API Request signing","slug":"api-request-signing"},{"content":"Callbacks","slug":"callbacks"},{"content":"Payment Statuses - (V2 flow)","slug":"payment-statuses-v2-flow"},{"content":"Payments statuses - (Custody flow)","slug":"payments-statuses-custody-flow"},{"content":"Multiple deposit processing","slug":"multiple-deposit-processing"},{"content":"Automated mistaken deposits processing","slug":"automated-mistaken-deposits-processing"},{"content":"Static deposit address per each customer","slug":"static-deposit-address-per-each-customer"},{"content":"API errors code description","slug":"api-errors-code-description"}],"owner":"17469357","collectionId":"314c91b8-624c-4189-a3bb-7bd5331329a0","publishedId":"UVyvwv7a","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-07T15:34:54.000Z"},"item":[{"name":"V2 Flow","item":[{"name":"Common","item":[{"name":"Rates","event":[{"listen":"prerequest","script":{"id":"07e75beb-0df3-472e-821b-27328cfea014","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret')"," ? pm.environment.get('api-secret')"," : pm.variables.has('api-secret')"," ? pm.variables.get('api-secret')"," : pm.globals.has('api-secret')"," ? pm.globals.get('api-secret')"," : pm.collectionVariables.has('api-secret')"," ? pm.collectionVariables.get('api-secret')"," : console.error(new Error('api-secret is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","console.log('payload', payload);","","const sign = crypto.HmacSHA512(payload, secret).toString();","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript"}}],"id":"516cd862-ec92-4849-8773-1a01515f84a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v2/rate?currencyFrom=usd¤cyTo=sol&transactionType=deposit","description":"This method allows you to get crypto to crypto or fiat to crypto exchange rate.
\ncurrencyFrom - fiat or cryptocurrency;
\ncurrencyTo - cryptocurrency;
\ntransactionType - always deposit or withdrawal.
\nResponse fields:
\nrate - shows an amount of currencyTo per 1 currencyFrom;
\nreverseRate - shows an amount of currencyFrom per 1 currencyTo.
\nGet available crypto and fiat currencies by using the method GET \"Supported currencies\".
\n","urlObject":{"protocol":"https","path":["v2","rate"],"host":["api","heropayments","io"],"query":[{"key":"currencyFrom","value":"usd"},{"key":"currencyTo","value":"sol"},{"key":"transactionType","value":"deposit"}],"variable":[]}},"response":[{"id":"bee6f6db-0333-4a86-b90f-064bf55bac87","name":"Exchange rate","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"currencyFrom\": \"usd\",\r\n \"currencyTo\": \"sol\",\r\n \"transactionType\": \"deposit\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v2/rate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 May 2022 14:10:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"132"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"X-Request-ID","value":"42bcc76d3f16ee8e7e34089d3b60d2e3"}],"cookie":[],"responseTime":null,"body":"{\n \"currencyFrom\": \"usd\",\n \"currencyTo\": \"sol\",\n \"transactionType\": \"deposit\",\n \"rate\": \"0.009344788065158223162995988\",\n \"reverseRate\": \"107.4502406750799836205991875\"\n}"}],"_postman_id":"516cd862-ec92-4849-8773-1a01515f84a5"},{"name":"Supported currencies","event":[{"listen":"prerequest","script":{"id":"dfce1d4c-f35b-416d-9e25-ccc550b2890d","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret')"," ? pm.environment.get('api-secret')"," : pm.variables.has('api-secret')"," ? pm.variables.get('api-secret')"," : pm.globals.has('api-secret')"," ? pm.globals.get('api-secret')"," : pm.collectionVariables.has('api-secret')"," ? pm.collectionVariables.get('api-secret')"," : console.error(new Error('api-secret is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","console.log('payload', payload);","","const sign = crypto.HmacSHA512(payload, secret).toString();","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript"}}],"id":"699875a1-914c-4a63-ae69-204f7ab5626d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"url":"https://api.heropayments.io/v2/currencies","description":"By using this method, you can see the list of supported cryptocurrencies.
\nYou can also set ?fiat=true to get the list of supported fiat currencies.
ticker - shortened name of the currency
fullName - name of the currency
extraIdName - extra id of the currency, if it has one
isStable - shows if the currency is a stablecoin or not
confirmations - shows the number of confirmation blocks of the currency
blockchain - shows the blockchain currency is operated on
image - svg icon of the currency
To retrieve minimum amounts for all supported cryptocurrencies in bulk, call v2/min-amount.
To get the minimum amount for a specific cryptocurrency, use the currency query parameter, for example: ?currency=btc.
To retrieve minimum amounts for all cryptocurrencies estimated in fiat, callv2/min-amount?baseCurrency=usd.
Response fields:
\nminDeposit — minimum amount required for a deposit transaction
minWithdrawal — minimum amount required to create a withdrawal transaction
currency — cryptocurrency
baseCurrency — fiat currency
The list of supported cryptocurrencies and fiat currencies can be obtained via the GET \"Supported currencies\".
\n","urlObject":{"protocol":"https","path":["v2","min-amount"],"host":["api","heropayments","io"],"query":[{"key":"currency","value":"eth"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"a87a30a4-0712-4938-873b-c92d4ddbf199","name":"Get the minimum payment amount","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"url":{"raw":"https://api.heropayments.io/v2/min-amount?currency=eth","protocol":"https","host":["api","heropayments","io"],"path":["v2","min-amount"],"query":[{"key":"currency","value":"eth"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Jun 2022 13:05:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"X-Request-ID","value":"1192e721b53d30b074480b84423f556a"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=%2F7pmmziJSpfut6Zxz6t%2FHZIL6nIVzln4c%2BFZXI3%2BcH8WNCWWjAHsr9vLwsXAUH9f6ECdf0YccVI7WlqEwDt%2FsYEBSf0%2FY7BHYrUaKBtrYrXek4lCQNrHhQbhJcvQpolDM%2Fvykaoh\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"71715bdabab30afe-OSL"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"minDeposit\": 0.07679,\n \"minWithdrawal\": 0.07679,\n \"currency\": \"eth\"\n}"}],"_postman_id":"74245569-2457-46f7-bbce-55df4d9d4229"},{"name":"Payment status check by id (V2)","event":[{"listen":"prerequest","script":{"id":"741259d5-b6d5-48af-860c-a9348fa196da","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret')"," ? pm.environment.get('api-secret')"," : pm.variables.has('api-secret')"," ? pm.variables.get('api-secret')"," : pm.globals.has('api-secret')"," ? pm.globals.get('api-secret')"," : pm.collectionVariables.has('api-secret')"," ? pm.collectionVariables.get('api-secret')"," : console.error(new Error('api-secret is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","console.log('payload', payload);","","const sign = crypto.HmacSHA512(payload, secret).toString();","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript"}}],"id":"f850d90d-7926-46f6-bcbf-4b90369cbbf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"your_api_key"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.heropayments.io/v2/payments/:id","description":"To get information about the status of a deposit/withdrawal, you need to provide a payment ID.
\nNOTE! GET \"Payment status check by id (V2)\" request should be made with the same API key that you used to create a deposit/withdrawal\"request.
\nPossible statuses:
\nwaiting - the initial status of each deposit and withdrawal. Waiting for a transaction to appear in a blockchain;
\nconfirming - waiting for confirmations in a blockchain. There is a minimum required amount of confirmations to consider a crypto transaction finished;
\nexchanging - crypto exchange process. In case of deposits: from a client's payCurrency to the merchant's balance currency. In case of withdrawals: from the merchant's balance currency to the client's payoutCurrency;
\nsending - crypto is on its way to the merchant’s wallet (deposit scenario) or the user’s wallet (withdrawal scenario). Considered as a \"success\" status for deposits only;
\nfinished - the transaction is processed successfully. Considered as a \"success\" status;
\nfailed - the transaction is failed due to an error;
\nrefunded - the funds were refunded back to the user’s/Merchant’s wallet;
\nhold - the transaction is marked as suspicious and the user must pass KYC procedure;
\nexpired - the user didn't send the funds to the specified address in the 4 hour time window, and the created payment expired.
\nMore information could be found in Payments statuses - (V2 flow)
\nPLEASE NOTE!
\nWe recommend setting up 2 \"success\" statuses: finished and sending as well. Sending - means “money is on our side, and we are transferring it to your balance”.
\nResponse fields:
\nId – payment ID;
\nstatus – status of the transaction;
\nid – invoice ID;
\ncustomerID – ID of the customer;
\norderID – the value is identical to externalOrderId;
\npriceCurrency - user's account currency: fiat or cryptocurrency (ex. USD, EUR, BTC, etc.);
\npriceAmount - amount specified by user for a deposit/withdrawal in priceCurrency;
\nexternalOrderId - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\nsequence - helps to differentiate between the subsequent payments. More information could be found in multiple deposit processing;
\ncustomerEmail - user’s email address;
\ntransactionType - always deposit or withdrawal;
\npayCurrency - cryptocurrency for the transaction (specified by user);
\npayAmount:
- for deposits - how much the user must pay to complete a deposit;
- for withdrawals - the amount that will be deducted from the merchant's balance to process a withdrawal;
payAddress - deposit address for crypto assets;
\npayExtra - additional Id which is necessary for identifying a recipient of the transaction. Also known as additional address, memo or destination tag. Users must enter it while withdrawing XRP, BNB, XLM and some other currencies;
\npayHash:
- for deposits - transaction hash to the deposit address;
- for withdrawals - transaction hash from the merchant’s balance address to an exchange address;
payHashLink - link to transaction hash;
\nuserNotes - notes left by user;
\ncreatedAt - time, when the transaction was created;
\npaidAmount - amount that was actually sent in the transaction;
\noutcomeHash:
- for deposits - transaction hash from an exchange address to the merchant’s balance address;
- for withdrawals - transaction hash from an exchange address to user’s wallet address;
outcomeHashLink - link to transaction hash;
\noutcomeAmount:
- for deposits - amount credited to the merchant’s wallet.
- for withdrawals - amount received by user in specified cryptocurrency;
outcomeAddress:
- for deposits - merchant's crypto wallet, which is used to сollect deposits;
- for withdrawals - user’s address to receive the withdrawal;
payinSenders - customer's wallet, used to process a deposit or merchant’s wallet to proceed a withdrawal;
\nfiat - parameter to specify in priceCurrency. True is set by default. Pass false to create a transaction with crypto estimation, if the user's account is in crypto.
\nTo get information about the status of a deposit/withdrawal, you need to provide an Order ID (externalOrderId).
\nStatuses and response fields are identical to Payment status check by id (V2)
\n","urlObject":{"protocol":"https","path":["v2","payments","order",":orderId"],"host":["api","heropayments","io"],"query":[],"variable":[{"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"59cb3653-70d2-46e4-b057-fc01cfcda59e","name":"Payment status check by Order id (V2)","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"url":{"raw":"https://api.heropayments.io/v2/payments/order/:orderId","protocol":"https","host":["api","heropayments","io"],"path":["v2","payments","order",":orderId"],"variable":[{"key":"orderId","value":"100244503"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5e31fc03-3d19-4448-f33-0655f53dfdc4\",\n \"status\": \"finished\",\n \"invoice\": {\n \"id\": \"113099ab-66c7-4db6-a438-f9a361467177\",\n \"customerId\": \"Jean105\",\n \"orderId\": \"100244503\",\n \"priceCurrency\": \"usd\",\n \"priceAmount\": 55\n },\n \"externalOrderId\": \"100244503\",\n \"sequence\": \"original\",\n \"customerEmail\": null,\n \"transactionType\": \"deposit\",\n \"payCurrency\": \"doge\",\n \"payAmount\": 301.84996815,\n \"payAddress\": \"DJZheBRYjn2jgrdroh4VY7LkLPmxvaj\",\n \"payExtra\": null,\n \"payHash\": \"9509f5c326e4894668ea714f8f9d7bc590417d1c762e318d591fcb90b90c62\",\n \"payHashLink\": \"https://dogechain.info/tx/9509f5c326e4894668ea714f8f9d7bc590417d1c762e318d591fcb90b90c62\",\n \"userNotes\": null,\n \"createdAt\": \"2025-03-24T14:22:53.000Z\",\n \"paidAmount\": 20,\n \"outcomeHash\": \"0xef965649b6b292d24530b3c0753de2feafce2fe090988465f6f9b565b7196\",\n \"outcomeHashLink\": \"https://bscscan.com/tx/0xef965649b6b292d24530b3c0753de2feafce2fe090988465f6f9b565b7196\",\n \"outcomeAmount\": 3.2928841,\n \"outcomeAddress\": \"0x0952900601c6864b8027fde1d061ef03d62fa3\",\n \"outcomeCurrency\": \"usdtbsc\",\n \"feePercent\": 0.5,\n \"feeUSDT\": 0.01805469,\n \"networkFee\": 0.3,\n \"priceRate\": 0.9998,\n \"payRate\": 0.18054694,\n \"clientAmountUsdt\": 3.6109388,\n \"clientAmount\": 3.61,\n \"merchantAmountUsdt\": 3.2928841,\n \"callbackUrl\": \"https://webhook.site/03adbbc2-df75-48-b33-10b84255c74f\",\n \"payinSenders\": [\n \"D6jRFkAtSS57iMW66BpxYebMDg6oDJqm\"\n ],\n \"fiat\": true\n}"}],"_postman_id":"fa7c9e0f-d411-4dcb-9fea-8e358958b6a9"},{"name":"List of payments (V2)","event":[{"listen":"prerequest","script":{"id":"741259d5-b6d5-48af-860c-a9348fa196da","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret')"," ? pm.environment.get('api-secret')"," : pm.variables.has('api-secret')"," ? pm.variables.get('api-secret')"," : pm.globals.has('api-secret')"," ? pm.globals.get('api-secret')"," : pm.collectionVariables.has('api-secret')"," ? pm.collectionVariables.get('api-secret')"," : console.error(new Error('api-secret is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","console.log('payload', payload);","","const sign = crypto.HmacSHA512(payload, secret).toString();","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"1d076c4d-e496-462e-b153-7f9e57b7f9e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"your_api_key"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.heropayments.io/v2/payments?search","description":"Returns the entire list of all transactions, created with a certain API key. The list of optional parameters:
\nlimit - limits amount of transactions on a page;
\noffset - specified to exclude a number of entries from the query;
\nstatus - payment statuses: \"waiting\", \"exchanging\", \"sending\", \"finished\";
\ntransactionType - always \"deposit\" or \"withdrawal\";
\nid - payment ID;
\ninvoiceId - invoice ID;
\nexternalOrderId - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\ncustomerEmail - user’s email address;
\ncustomerId - the merchant provides an ID that is associated with a particular user of the platform;
\npayAddress - deposit address for crypto assets;
\npayCurrency - chosen cryptocurrency for a deposit/withdrawal;
\npriceCurrency - user's account currency: fiat or cryptocurrency;
\ndateFrom - select the displayed period start date (date format: YYYY-MM-DD or yy-MM-ddTHH:mm:ss.SSSZ);
\ndateTo - select the displayed period end date (date format: YYYY-MM-DD or yy-MM-ddTHH:mm:ss.SSSZ).
\nAdditionally, there is possibility to find transactions via \"search\" parameter, where you can write in: id, invoiceId, externalOrderId, customerEmail, payAddress, hash.
\n","urlObject":{"protocol":"https","path":["v2","payments"],"host":["api","heropayments","io"],"query":[{"disabled":true,"key":"limit","value":"40"},{"disabled":true,"key":"status","value":"finished"},{"disabled":true,"key":"dateFrom","value":"2022-11-07"},{"disabled":true,"key":"dateTo","value":"2022-11-29"},{"disabled":true,"key":"transactionType","value":"deposit"},{"key":"search","value":null}],"variable":[]}},"response":[],"_postman_id":"1d076c4d-e496-462e-b153-7f9e57b7f9e2"},{"name":"Get balance (V2)","event":[{"listen":"prerequest","script":{"id":"fa204e06-2931-4938-963b-4a1f1e75e53f","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret')"," ? pm.environment.get('api-secret')"," : pm.variables.has('api-secret')"," ? pm.variables.get('api-secret')"," : pm.globals.has('api-secret')"," ? pm.globals.get('api-secret')"," : pm.collectionVariables.has('api-secret')"," ? pm.collectionVariables.get('api-secret')"," : console.error(new Error('api-secret is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","console.log('payload', payload);","","const sign = crypto.HmacSHA512(payload, secret).toString();","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript"}}],"id":"51715a30-cf5e-4237-8815-2d3228311cd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"url":"https://api.heropayments.io/v2/balance","description":"This method returns your balance.
\n","urlObject":{"protocol":"https","path":["v2","balance"],"host":["api","heropayments","io"],"query":[],"variable":[]}},"response":[{"id":"bfe810f0-e600-4bdb-aff2-2e8193cdd04e","name":"Get balance","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v2/balance"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"walletAddress\": \"THqRUngDUejfE6TwM9XhynBAA6qhW6ZWit\",\n \"walletCurrency\": \"usdttrc20\",\n \"balance\": \"333.80103\"\n}"}],"_postman_id":"51715a30-cf5e-4237-8815-2d3228311cd7"},{"name":"Network fees (V2)","event":[{"listen":"prerequest","script":{"id":"4701aa82-b94d-4497-bc46-db5d5cf7210f","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret')"," ? pm.environment.get('api-secret')"," : pm.variables.has('api-secret')"," ? pm.variables.get('api-secret')"," : pm.globals.has('api-secret')"," ? pm.globals.get('api-secret')"," : pm.collectionVariables.has('api-secret')"," ? pm.collectionVariables.get('api-secret')"," : console.error(new Error('api-secret is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","console.log('payload', payload);","","const sign = crypto.HmacSHA512(payload, secret).toString();","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"1331dffb-239f-4da4-8042-6d05ee882da8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.heropayments.io/v2/network-fees","description":"This method returns current network fees (bulk) associated with deposits and withdrawals for various cryptocurrencies.
\nnetworkfee – network Fee to perform the blockchain transaction in USDT equivalent;
\nticker – API currency symbols;
\ntype – the type of transaction, which can be either \"deposit\" or \"withdrawal\".
\nUse this method to create a deposit transaction. Please provide your data as a JSON-object payload.
\nRequest fields:
\npayCurrency (required) - cryptocurrency for the deposit (specified by user);
\npriceCurrency (required) - the currency in user’s player account;
\npriceAmount (required) - amount specified by user for deposit in a priceCurrency;
\ncustomerId (required) - the merchant provides an ID that is associated with a particular user of the platform;
\ncustomerEmail (optional) - user’s email address;
\nexternalOrderId (required) - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\ncallbackUrl (optional) - HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries;
\nfiat - parameter to specify in priceCurrency. True is set by default. Pass false to create a transaction with crypto estimation, if the user's player account is in crypto.
\nResponse fields:
\nid - payment ID;
\nstatus - status of the transaction;
\nid - invoice ID;
\ncustomerID - ID of the customer;
\norderID - the value is identical to externalOrderId;
\npriceCurrency - user's account currency: fiat or cryptocurrency (ex. USD, EUR, BTC, etc);
\npriceAmount - amount specified by user for the deposit in priceCurrency.
\nexternalOrderId - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\nsequence - helps to differentiate between the subsequent payments. Please read multiple deposit processing;
\ncustomerEmail - user’s email address;
\ntransactionType - always deposit or withdrawal, in this case deposit;
\npayCurrency - cryptocurrency for the transaction (specified by user);
\npayAmount - expected amount to pay by the user;
\npayAddress - deposit address for crypto assets;
\npayHash - transaction hash to the deposit address;
\npayHashLink - link to transaction hash;
\nuserNotes - notes left by user;
\ncreatedAt - time, when the transaction was created;
\npaidAmount - amount that was actually sent in the transaction;
\noutcomeAmount - amount credited to the merchant’s wallet;
\noutcomeCurrency - all deposits are accumulated in the merchant's balance currency;
\nfeePercent - Heropayments processing fee;
\nfeeUSDT - Heropayments processing fee in USDT equivalent;
\nnetworkFee - network fee deducted for processing the blockchain transaction;
\npriceRate - priceCurrency to outcomeCurrency ratio;
\npayRate - payCurrency to outcomeCurrency ratio;
\nclientAmountUsdt - deposit amount received from a user and converted to USDT;
\nclientAmount - fiat equivalent of clientAmountUsdt in priceCurrency. Shows the amount to be credited to users' account;
\nmerchantAmountUsdt - amount credited to Merchant’s wallet in USDT. Equals to outcomeAmount;
\ncallbackUrl - HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries;
\npayinSenders - the address from which the funds were originally sent (the customer’s wallet address);
\nfiat - parameter to specify in priceCurrency. True is set by default. Pass false to create a transaction with crypto estimation, if the user's account is in crypto.
\nYou can check the status of the payment via GET \"Payment status check by id (V2)\"
\n","urlObject":{"protocol":"https","path":["v2","payments"],"host":["api","heropayments","io"],"query":[],"variable":[]}},"response":[{"id":"b47a6629-7bd6-410e-8f91-594a8150fd7c","name":"Create deposit","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_body","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"payCurrency\": \"usdttrc20\",\r\n \"priceCurrency\": \"usd\",\r\n \"priceAmount\": \"34\",\r\n \"customerId\": \"123\",\r\n \"customerEmail\": \"test@te34st.com\",\r\n \"externalOrderId\": \"145432115\",\r\n \"callbackUrl\": \"https://example.com/callback\"","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v2/payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jun 2022 08:23:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"X-Request-ID","value":"97fca46a545874cc7ee3b0aba50417b4"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=i1CV4jpvwrK31XIw08VrdthFnr6%2FQbjIcekV8kgc3KwJD4aU9SKYIlnTzE2yKQ67S5YYEFtIFSj3ghX6fl30jB47pAY%2BDxwA6E8KCxdNzAllG6PXb6F7p0ZNxNvRFgYCOH0mwEKv\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"714ec8d269694151-HAM"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2d97cc2c-4804-41ed-a303-0b37bcb2766ee\",\n \"status\": \"waiting\",\n \"invoice\": {\n \"id\": \"8d767275-cc59-4743-839c-3bd729f212460\",\n \"customerId\": \"testuser\",\n \"orderId\": \"453453453453\",\n \"priceCurrency\": \"usd\",\n \"priceAmount\": 34\n },\n \"externalOrderId\": \"453453453453\",\n \"sequence\": \"original\",\n \"customerEmail\": \"test@gmail.com\",\n \"transactionType\": \"deposit\",\n \"payCurrency\": \"usdttrc20\",\n \"payAmount\": 34.54795216,\n \"payAddress\": \"THqRUngDUejfE6TwM9XhynBAA6qhW6ZWit\",\n \"payExtra\": null,\n \"payHash\": null,\n \"userNotes\": null,\n \"createdAt\": \"2025-04-09T13:08:54.000Z\",\n \"paidAmount\": 0,\n \"outcomeAmount\": 0,\n \"outcomeCurrency\": \"usdt20\",\n \"feePercent\": 0.5,\n \"feeUSDT\": 0,\n \"networkFee\": 0.5,\n \"priceRate\": 1.001,\n \"payRate\": 0.99959615,\n \"clientAmountUsdt\": 0,\n \"clientAmount\": 0,\n \"merchantAmountUsdt\": 0,\n \"callbackUrl\": null,\n \"payinSenders\": [],\n \"fiat\": true\n}"}],"_postman_id":"412c5848-dbed-42c5-980b-a3060e9e8c46"},{"name":"Create a deposit (address only)","event":[{"listen":"prerequest","script":{"id":"2d30c647-6813-4979-a836-bcb6e6a28334","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret')"," ? pm.environment.get('api-secret')"," : pm.variables.has('api-secret')"," ? pm.variables.get('api-secret')"," : pm.globals.has('api-secret')"," ? pm.globals.get('api-secret')"," : pm.collectionVariables.has('api-secret')"," ? pm.collectionVariables.get('api-secret')"," : console.error(new Error('api-secret is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","console.log('payload', payload);","","const sign = crypto.HmacSHA512(payload, secret).toString();","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"8b0e55de-3557-494e-bdc1-c7cc28234288","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_body","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payCurrency\": \"usdttrc20\",\n \"priceCurrency\": \"usd\",\n \"customerId\": \"123\",\n \"customerEmail\": \"test@test.com\",\n \"externalOrderId\": \"1245411536\",\n \"callbackUrl\": \"https://example.com/callback\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v2/payments-address","description":"This method provides a streamlined way to generate a deposit address without performing amount or exchange rate calculations.
\nThe v2/payments-address endpoint behaves identically to v2/payments in terms of statuses and supported features, but offers a faster response time.
Use cases: gambling deposits, donations, and other scenarios where the deposit amount does not need to be converted to a local fiat currency. You simply display the generated deposit address (payAddress) to the user to receive funds.
Once the payment is completed, a callback is sent containing the actual deposited amount.
\n","urlObject":{"protocol":"https","path":["v2","payments-address"],"host":["api","heropayments","io"],"query":[],"variable":[]}},"response":[{"id":"d45b032a-3ca1-4ad2-8b39-280a36cccd7a","name":"Create deposit","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_body","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"payCurrency\": \"usdttrc20\",\r\n \"priceCurrency\": \"usd\",\r\n \"customerId\": \"123\",\r\n \"customerEmail\": \"test@test.com\",\r\n \"externalOrderId\": \"1245411536\",\r\n \"callbackUrl\": \"https://example.com/callback\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v2/payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jun 2022 08:23:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"X-Request-ID","value":"97fca46a545874cc7ee3b0aba50417b4"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=i1CV4jpvwrK31XIw08VrdthFnr6%2FQbjIcekV8kgc3KwJD4aU9SKYIlnTzE2yKQ67S5YYEFtIFSj3ghX6fl30jB47pAY%2BDxwA6E8KCxdNzAllG6PXb6F7p0ZNxNvRFgYCOH0mwEKv\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"714ec8d269694151-HAM"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9753658a-3b9d-4a14-b931-bbec23da345\",\n \"status\": \"waiting\",\n \"invoice\": {\n \"id\": \"34a40436-12e5-46b2-b0ab-89ae76b872b\",\n \"customerId\": \"123\",\n \"orderId\": null,\n \"priceCurrency\": \"usd\",\n \"priceAmount\": 0\n },\n \"externalOrderId\": \"1245411536\",\n \"sequence\": \"original\",\n \"customerEmail\": \"test@test.com\",\n \"transactionType\": \"deposit\",\n \"payCurrency\": \"usdttrc20\",\n \"payAmount\": 0,\n \"payAddress\": \"THqRUngDUejfE6TwM9XhynBAA6qhW6ZWit\",\n \"payExtra\": null,\n \"payHash\": null,\n \"userNotes\": null,\n \"createdAt\": \"2025-04-10T10:49:52.000Z\",\n \"paidAmount\": 0,\n \"outcomeAmount\": 0,\n \"outcomeCurrency\": \"usdt20\",\n \"feePercent\": 0.5,\n \"feeUSDT\": 0,\n \"networkFee\": 0.5,\n \"priceRate\": 1,\n \"payRate\": 1,\n \"clientAmountUsdt\": 0,\n \"clientAmount\": 0,\n \"merchantAmountUsdt\": 0,\n \"callbackUrl\": \"https://example.com/callback\",\n \"fiat\": true\n}"}],"_postman_id":"8b0e55de-3557-494e-bdc1-c7cc28234288"},{"name":"Create an invoice (widget)","event":[{"listen":"prerequest","script":{"id":"a0c98327-848b-47a2-9f2b-aeb03f6e4452","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret')"," ? pm.environment.get('api-secret')"," : pm.variables.has('api-secret')"," ? pm.variables.get('api-secret')"," : pm.globals.has('api-secret')"," ? pm.globals.get('api-secret')"," : pm.collectionVariables.has('api-secret')"," ? pm.collectionVariables.get('api-secret')"," : console.error(new Error('api-secret is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","console.log('payload', payload);","","const sign = crypto.HmacSHA512(payload, secret).toString();","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"7f594c26-bdfe-4a0d-a7c8-007efe82a797","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_body","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"priceCurrency\": \"usdttrc20\",\r\n \"priceAmount\": \"34\",\r\n \"customerId\": \"123\",\r\n \"externalOrderId\": \"64536456\",\r\n \"successUrl\": \"https://www.google.com/?hl=en\",\r\n \"failUrl\": \"https://en.wikipedia.org/wiki/Main_Page\",\r\n \"callbackUrl\": \"https://example.com/callback\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v2/invoices","description":"The customer must open the generated invoiceUrl to complete the deposit. On the payment widget, the customer selects the cryptocurrency to use for the payment.
Depending on the payment outcome, the customer is redirected to either successUrl or failUrl.
Payment widget DEMO VIDEO -
https://drive.google.com/file/d/1zpgT5U34Ysc7Wq83zWpinldic2yji0qc/view?usp=drive_link
Request fields:
\npriceCurrency (required) - the currency in user’s player account in which the priceAmount is specified and displayed on the widget;
\npriceAmount (required) - amount specified by user for the deposit in priceCurrency;
\ncustomerId (required) - the merchant provides an ID that is associated with a particular user of the platform;
\nexternalOrderId (required) - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\nsuccessUrl (optional) - merchant's URL after a successful payment. Also known as \"thank-you page\";
\nfailUrl (optional) - merchant's URL when the customer cancels the order. Also known as \"cancel page\";
\ncallbackUrl (optional) - HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries;
\nResponse fields:
\nid - invoice ID
\ncustomerId - the merchant provides an ID that is associated with a particular user of the platform;
\npriceAmount - amount specified by user for the deposit in priceCurrency;
\npriceCurrency - user's account currency: fiat or cryptocurrency (ex. USD, EUR, BTC, etc.);
\nexternalOrderId - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\norderDescription - notes about the order;
\nsuccessUrl (optional) - redirects to Merchant's URL after successful payment. Also known as \"thank-you page\";
\nfailUrl (optional) - redirects to Merchant's URL when a customer cancels the order. Also known as \"cancel page\";
\ninvoiceUrl - Heropayments hosted URL to redirect customers to proceed the deposit;
\ncallbackUrl - HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries;
\ncreatedAt - time, when the invoice was created;
\nfiat - parameter to specify in priceCurrency. True is set by default. Pass false to create a transaction with crypto estimation, if the user's account is in crypto.
\nIn addition to creating an invoice (widget), this method supports creating an invoice with a predefined cryptocurrency. In this case, the user skips the initial step of selecting a payment currency, as it is already specified.
\nEnter the right cryptocurrency in payCurrency to redirect your user to the payment.
\n","urlObject":{"protocol":"https","path":["v2","invoices"],"host":["api","heropayments","io"],"query":[],"variable":[]}},"response":[{"id":"ef57f7ce-54ec-45b6-a4b9-399195ff095a","name":"Create an invoice (widget - chosen currency)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_body","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"priceCurrency\": \"doge\",\n \"priceAmount\": \"50\",\n \"customerId\": \"123\",\n \"payCurrency\":\"usdttrc20\",\n \"externalOrderId\": \"64456545645\",\n \"successUrl\": \"https://www.google.com/?hl=en\",\n \"failUrl\": \"https://en.wikipedia.org/wiki/Main_Page\",\n \"callbackUrl\": \"https://example.com/callback\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v2/invoices"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"fdaf664c-6ce4-4e45-b56b-ab402ecb3d6e\",\n \"customerId\": \"123\",\n \"priceAmount\": \"50\",\n \"priceCurrency\": \"doge\",\n \"externalOrderId\": \"64456545645\",\n \"orderDescription\": null,\n \"successUrl\": \"https://www.google.com/?hl=en\",\n \"failUrl\": \"https://en.wikipedia.org/wiki/Main_Page\",\n \"invoiceUrl\": \"https://pay.heropayments.io/pay/fdaf664c-6ce4-4e45-b56b-ab402ecb3d6e\",\n \"callbackUrl\": \"https://example.com/callback\",\n \"createdAt\": \"2025-04-10T11:58:41.000Z\",\n \"fiat\": false\n}"}],"_postman_id":"849d8eb4-1f33-4e59-b442-a9f70093ca19"}],"id":"3b30d83d-5046-40bd-a6f9-d074bf93c9c3","_postman_id":"3b30d83d-5046-40bd-a6f9-d074bf93c9c3","description":""},{"name":"Withdrawals","item":[{"name":"Create a withdrawal (V2)","event":[{"listen":"prerequest","script":{"id":"8c3ee447-3cd2-4150-bb3e-58bd42a78867","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret')"," ? pm.environment.get('api-secret')"," : pm.variables.has('api-secret')"," ? pm.variables.get('api-secret')"," : pm.globals.has('api-secret')"," ? pm.globals.get('api-secret')"," : pm.collectionVariables.has('api-secret')"," ? pm.collectionVariables.get('api-secret')"," : console.error(new Error('api-secret is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","console.log('payload', payload);","","const sign = crypto.HmacSHA512(payload, secret).toString();","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"a4e3c2d9-c88d-417e-90eb-947fc8eb9c10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"123\",\r\n \"payoutAddress\": \"0x846CD889507F93E8E077E4813B9341ABA9fBA3B2\",\r\n \"payoutCurrency\": \"usdt20\",\r\n \"priceCurrency\":\"usd\",\r\n \"priceAmount\": \"3\",\r\n \"payoutExtraId\": \"\",\r\n \"customerEmail\": \"test@test.com\",\r\n \"externalOrderId\": \"123453356744123a\",\r\n \"callbackUrl\": \"https://example.com/callback\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v2/withdrawal","description":"Use this method to create a withdrawal (payout) transaction. Please provide your data as a JSON-object payload.
\nRequest fields:
\ncustomerId (required) - the merchant provides an ID that is associated with a particular user of the platform;
\npayoutAddress (required) - your user’s address to receive the withdrawal;
\npayoutCurrency (required) - chosen cryptocurrency for the withdrawal;
\npriceCurrency (required) - how much will receive a user in estimated value;
\npriceAmount (required) - amount specified by user for withdrawal in priceCurrency;
\ncustomerEmail (optional) - user’s email;
\npayoutExtraId (optional) - additional Id which is necessary for identifying a recipient of the transaction. Also known as additional address, memo or destination tag. Users must enter it while withdrawing XRP, BNB, XLM and some other currencies;
\nexternalOrderId (required) - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\ncallbackUrl (optional) - HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries;
\nfiat - parameter to specify in priceCurrency. True is set by default. Pass false to create a transaction with crypto estimation, if the user's account is in crypto.
\nResponse fields:
\nid - payment ID;
\nstatus - status of the transaction;
\nid - invoice ID;
\ncustomerID - ID of the customer;
\npriceCurrency - user's account currency: fiat or cryptocurrency (ex. USD, EUR, BTC, etc.);
\npriceAmount - amount specified by user for the deposit in priceCurrency;
\ncustomerEmail - user’s email address;
\nsequence - used for deposits only, for withdrawals remains \"original\";
\nexternalOrderId - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\ntransactionType - always deposit or withdrawal, in this case withdrawal;
\npayCurrency - cryptocurrency for the transaction (specified by user);
\npayAmount - the amount that must be deducted from the merchant's account to process a withdrawal;
\noutcomeAddress - user’s address to receive the withdrawal’
\npayExtra - additional Id which is necessary for identifying a recipient of the transaction. Also known as additional address, memo or destination tag. Users must enter it while withdrawing XRP, BNB, XLM and some other currencies;
\npayHash - transaction hash from the merchant’s balance address to an exchange address;
\ncreatedAt - time, when the transaction was created;
\npaidAmount - amount that was actually sent in the transaction;
\noutcomeAmount - the amount that a user must receive for a withdrawal;
\noutcomeCurrency - a currency that the user chose for the withdrawal;
\nfeePercent - Heropayments processing fee (%);
\nfeeUSDT - Heropayments processing fee in the Currency equivalent;
\nnetworkFee - network fee deducted for processing the blockchain transaction;
\npriceRate - priceCurrency to outcomeCurrency ratio;
\npayRate - payCurrency to outcomeCurrency ratio;
\nclientAmountUsdt - USDT equivalent of a withdrawal amount sent to the user;
\nclientAmount - equivalent of priceAmount in priceCurrency. This amount that user should receive for a withdrawal;
\nmerchantAmountUsdt - USDT amount deducted from the mechant's balance to process a withdrawal for user;
\npayinSenders - merchant’s wallet to proceed a withdrawal;
\nfiat - parameter to specify in priceCurrency. True is set by default. Pass false to create a transaction with crypto estimation, if the user's account is in crypto.
\nYou can check the status of the payment via GET \"Payment status check by id (V2)\"
\nWe have 2 types of daily limits:
\nMerchant withdrawal limit – for the entire merchant account per day;
\nCustomer withdrawal limit – for each customerId per day.
\nTo set up the limits, reach us via partners@heropayments.io or contact your personal account manager.
\nIn case of an infrastructural error, the withdrawal goes to the withdrawal queue, if this option is turned on for your account.
\n","urlObject":{"protocol":"https","path":["v2","withdrawal"],"host":["api","heropayments","io"],"query":[],"variable":[]}},"response":[{"id":"d8938945-6676-472b-938c-f565f943a09d","name":"Create withdrawal","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_body","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"123\",\r\n \"payoutAddress\": \"0x846CD889507F93E8E077E4813B9341ABA9fBA3B2\",\r\n \"payoutCurrency\": \"usdt20\",\r\n \"priceCurrency\":\"usd\",\r\n \"priceAmount\": \"3\",\r\n \"payoutExtraId\": \"\",\r\n \"customerEmail\": \"test@test.com\",\r\n \"externalOrderId\": \"123453356744123a\",\r\n \"callbackUrl\": \"https://example.com/callback\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v2/withdrawal"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"30d0e936-178e-4781-9133-abaab5318dca\",\n \"status\": \"waiting\",\n \"invoice\": {\n \"id\": \"4e25ebe9-a0aa-4979-b8b6-313ecd18c81e\",\n \"customerId\": \"123\",\n \"orderId\": null,\n \"priceCurrency\": \"usd\",\n \"priceAmount\": 3\n },\n \"externalOrderId\": \"123453356744123a\",\n \"sequence\": \"original\",\n \"customerEmail\": \"test@test.com\",\n \"transactionType\": \"withdrawal\",\n \"payCurrency\": \"usdt20\",\n \"payAmount\": 3.521126,\n \"payExtra\": null,\n \"payHash\": null,\n \"userNotes\": null,\n \"createdAt\": \"2025-04-10T12:55:05.000Z\",\n \"paidAmount\": 0,\n \"outcomeAmount\": 0,\n \"outcomeAddress\": \"0x846CD889507F93E8E077E4813B9341ABA9fBA3B2\",\n \"outcomeExtraId\": null,\n \"outcomeCurrency\": \"usdt20\",\n \"feePercent\": 0.6,\n \"feeUSDT\": 0.01810865,\n \"networkFee\": 0.5,\n \"priceRate\": 1,\n \"payRate\": 1,\n \"clientAmountUsdt\": 3.00301735,\n \"clientAmount\": 3,\n \"merchantAmountUsdt\": 3.521126,\n \"callbackUrl\": \"https://example.com/callback\",\n \"fiat\": true\n}"}],"_postman_id":"a4e3c2d9-c88d-417e-90eb-947fc8eb9c10"}],"id":"d9200fe3-376e-4cd1-a951-ce07c42ffdb5","_postman_id":"d9200fe3-376e-4cd1-a951-ce07c42ffdb5","description":""}],"id":"f51161d4-5cba-459f-a3ce-ba7e7d631f0d","_postman_id":"f51161d4-5cba-459f-a3ce-ba7e7d631f0d","description":""},{"name":"Custody flow","item":[{"name":"Common","item":[{"name":"Payment status check by id (Custody)","event":[{"listen":"prerequest","script":{"id":"5b2fe1d8-1ed4-476c-b761-7a6936d8caba","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret-custody')"," ? pm.environment.get('api-secret-custody')"," : pm.variables.has('api-secret-custody')"," ? pm.variables.get('api-secret-custody')"," : pm.globals.has('api-secret-custody')"," ? pm.globals.get('api-secret-custody')"," : pm.collectionVariables.has('api-secret-custody')"," ? pm.collectionVariables.get('api-secret-custody')"," : console.error(new Error('api-secret-custody is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","const sign = crypto.HmacSHA512(payload, secret).toString();","// console.log(secret, sign);","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"b62b5946-51fe-4d79-b818-4ff427dcf727","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"url":"https://api.heropayments.io/custody/payments/:id","description":"To get information about the status of a deposit/withdrawal, you need to provide a payment ID.
\nNOTE! GET \"Payment status check by id (Custody)\" request should be made with the same API key that you used to create a deposit/withdrawal request.
\nPossible statuses:
\nnew - the transaction was just created;
\npending - the transaction is waiting to be processed;
\nprocessing - the transaction is being processed;
\nfinished - the transaction is processed successfully. Considered as a \"success\" status;
\nfailed - the transaction is failed due to an error;
\nrefunded - the funds were refunded back to the user’s/Merchant’s wallet;
\nhold - the transaction is marked as suspicious and the user must pass KYC procedure;
\nexpired - the user didn't send the funds to the specified address during 4 hours and therefore the payment expired.
\nMore information could be found in Payments statuses - (Custody flow)
\nResponse fields:
\nid – payment ID;
\nsubEmail - if a payment was created by a subuser of the main account, the field reflects the name of the subaccount;
\ncurrency - currency of the transaction;
\namount - amount specified by user for the deposit/withdrawal in Currency
\nfeePercent - Heropayments processing fee (%);
\nfeeAmount - Heropayments processing fee in the Currency equivalent;
\nclientAmount:
- for deposits - amount of crypto received from a user to a created deposit address
- for withdrawals - amount sent to the user;
merchantAmount:
- for deposits - amount credited to the merchant’s wallet in Currency;
- for withdrawals - amount deducted from the merchant's balance to process the withdrawal for the user;
networkFee - network fee deducted for processing the blockchain transaction;
\ncustomerId - the merchant provides an ID that is associated with a particular user of the platform;
\nexternalOrderId - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\nsequence - helps to differentiate between the subsequent payments. More information could be found in multiple deposit processing;
\ncallbackUrl - HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries;
\ntransactionType - always deposit or withdrawal;
\naddress:
- for deposits - deposit address for crypto assets
- for withdrawals - destination address of your user where the crypto was withdrawn to;
addressExtra - additional Id which is necessary for identifying a recipient of the transaction. Also known as additional address, memo or destination tag. Users must enter it while withdrawing XRP, BNB, XLM and some other currencies;
\nstatus - status of the payment;
\nconfirmations - number of confirmations on the blockchain. We need to wait until the payment gets at least several confirmations to process it;
\nhash - transaction blockchain hash;
\nhashLink - link to hash;
\ncomment - additional information about the payment;
\ncreatedAt - time, when the transaction was created;
\nupdatedAt - time, when the transaction was updated.
\nTo get information about the status of a deposit/withdrawal, you need to provide an Order ID (externalOrderId).
\nStatuses and response fields are identical to Payment status check by id (Custody)
\n","urlObject":{"protocol":"https","path":["custody","payments","order",":orderId"],"host":["api","heropayments","io"],"query":[],"variable":[{"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"60f1121a-b845-4238-acd8-4971e6ef048e","name":"Payment status check by Order id (Custody)","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"url":{"raw":"https://api.heropayments.io/custody/payments/order/:orderId","protocol":"https","host":["api","heropayments","io"],"path":["custody","payments","order",":orderId"],"variable":[{"key":"orderId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9adb774a-75d5-4af5-8f6b-eb5654f4db\",\n \"subEmail\": null,\n \"currency\": \"usdtbsc\",\n \"feePercent\": 0.5,\n \"amount\": \"4\",\n \"feeAmount\": \"0.02\",\n \"clientAmount\": \"4\",\n \"merchantAmount\": \"4.32\",\n \"networkFee\": \"0.3\",\n \"customerId\": \"Tony\",\n \"externalOrderId\": \"Tony_salary_June\",\n \"callbackUrl\": null,\n \"transactionType\": \"withdrawal\",\n \"address\": \"0xf69ca466ac101702b2e8fcd06d2b4a2dd2887\",\n \"addressExtra\": \"\",\n \"status\": \"finished\",\n \"confirmations\": 0,\n \"hash\": \"0xa32ba5f98d490036fb1f37c2eb637ec77103e10b5e7f7618017dbc226083f\",\n \"hashLink\": \"https://bscscan.com/tx/0xa32ba5f98d490036fb1f37c2eb637ec77103e10b5e7f7618017dbc226083f\",\n \"comment\": \"June_salary\",\n \"createdAt\": \"2025-07-23T11:15:59.992Z\",\n \"updatedAt\": \"2025-07-23T11:16:50.884Z\"\n}"}],"_postman_id":"ec38a124-9231-4cc6-a6be-605a41bc3b14"},{"name":"List of payments (Custody)","event":[{"listen":"prerequest","script":{"id":"5b2fe1d8-1ed4-476c-b761-7a6936d8caba","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret-custody')"," ? pm.environment.get('api-secret-custody')"," : pm.variables.has('api-secret-custody')"," ? pm.variables.get('api-secret-custody')"," : pm.globals.has('api-secret-custody')"," ? pm.globals.get('api-secret-custody')"," : pm.collectionVariables.has('api-secret-custody')"," ? pm.collectionVariables.get('api-secret-custody')"," : console.error(new Error('api-secret-custody is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","const sign = crypto.HmacSHA512(payload, secret).toString();","// console.log(secret, sign);","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"1ec8d006-a284-4c79-b2ae-1a7e9d5761de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"url":"https://api.heropayments.io/custody/payments?offset=0&limit=10&status=finished&dateFrom=&dateTo=&transactionType=deposit","description":"Returns the entire list of all transactions, created with a certain API key. The list of optional parameters:
\nlimit - limits the amount of transactions on a page;
\noffset - specified to exclude a number of entries from the query;
\nstatus - payment statuses (\"new\", \"processing\", \"pending\", \"finished\");
\ntransactionType - always \"deposit\" or \"withdrawal\";
\ncurrency - currency of the transaction, the full list of supported currencies you can find here list of supported currencies;
\nhash - transaction blockchain hash
\nsubEmail - if a payment was created by a subuser of the main account, the field reflects the name of the subaccount;
\ncustomerId - the merchant provides an ID that is associated with a particular user of the platform;
\nexternalOrderId - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\naddress:
- for deposits - deposit address for crypto assets;
- for withdrawals - destination address of your user where the crypto was withdrawn to;
dateFrom - select the start date for the displayed period (date format: YYYY-MM-DD or yy-MM-ddTHH:mm:ss.SSSZ);
\ndateTo - select the end date for the displayed period (date format: YYYY-MM-DD or yy-MM-ddTHH:mm:ss.SSSZ).
\nPayments are sorted by createdAt (newest to oldest).
\n","urlObject":{"protocol":"https","path":["custody","payments"],"host":["api","heropayments","io"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"10"},{"key":"status","value":"finished"},{"key":"dateFrom","value":""},{"key":"dateTo","value":""},{"key":"transactionType","value":"deposit"}],"variable":[]}},"response":[],"_postman_id":"1ec8d006-a284-4c79-b2ae-1a7e9d5761de"},{"name":"Get balance (Custody)","event":[{"listen":"prerequest","script":{"id":"971c5c93-ea14-48b7-9fb8-a103add4e21d","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret-custody')"," ? pm.environment.get('api-secret-custody')"," : pm.variables.has('api-secret-custody')"," ? pm.variables.get('api-secret-custody')"," : pm.globals.has('api-secret-custody')"," ? pm.globals.get('api-secret-custody')"," : pm.collectionVariables.has('api-secret-custody')"," ? pm.collectionVariables.get('api-secret-custody')"," : console.error(new Error('api-secret-custody is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","const sign = crypto.HmacSHA512(payload, secret).toString();","// console.log(secret, sign);","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"8b8de6a1-fec5-4255-a087-1dece185ba01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"url":"https://api.heropayments.io/custody/balances","description":"Returns the entire list of all balances, created with a certain API key. The list of parameters:
\ncurrency - balance currency;
\ntotal - available + locked assets;
\navailable - amount of available assets on your balance;
\nusdEstimate - balance currency to USD ratio;
\nlocked - temporary locked assets. To get more information, reach out to the account team.
\nThis method returns the minimum amounts required to process deposit and withdrawal transactions.
\nTo retrieve minimum amounts for all supported cryptocurrencies in bulk, call custody/min-amount. To get the minimum amount for a specific cryptocurrency, use the currency query parameter, for example: ?currency=btc.
To retrieve minimum amounts for all cryptocurrencies estimated in fiat, call custody/min-amount?baseCurrency=usd.
Response fields:
\nminDeposit — minimum amount required for a deposit transaction
minWithdrawal — minimum amount required for a withdrawal transaction
currency — cryptocurrency code
The list of supported cryptocurrencies is available here - List of supported currencies
\n","urlObject":{"protocol":"https","path":["custody","min-amount"],"host":["api","heropayments","io"],"query":[],"variable":[]}},"response":[{"id":"1cf7b196-4e39-4ec9-80c5-d00e07cc0993","name":"Minimum payment amount","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"url":"https://api.heropayments.io/custody/min-amount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jul 2024 09:06:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"x-request-id","value":"fa252591d28e4c083fe21f226f76fb74"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=XSND73%2FSr%2FujjKCkKjKMGVzvHCApY9rbnkm51%2B51MhFBwIy8KK4jqxxROe%2Fy1mTb0mQVH%2FVQ3COAgb%2FpTrB4uRqXVppW2aR1widX3Nn1SMDlFW7jEIsgd7RLyS%2Fh5kDEudr80eNy\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8aabf35cde39801d-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"minDeposit\": 109.24253654,\n \"minWithdrawal\": 95.58721947,\n \"currency\": \"1inch\"\n },\n {\n \"minDeposit\": 12.14715063,\n \"minWithdrawal\": 12.14958055,\n \"currency\": \"ada\"\n },\n {\n \"minDeposit\": 84.99268339,\n \"minWithdrawal\": 84.99268339,\n \"currency\": \"algo\"\n },\n {\n \"minDeposit\": 10.47862411,\n \"minWithdrawal\": 10.47862411,\n \"currency\": \"alicebsc\"\n },\n {\n \"minDeposit\": 97.6285829,\n \"minWithdrawal\": 97.6285829,\n \"currency\": \"alpaca\"\n },\n {\n \"minDeposit\": 1300.6645527,\n \"minWithdrawal\": 1138.08148361,\n \"currency\": \"ankr\"\n },\n {\n \"minDeposit\": 64.11818382,\n \"minWithdrawal\": 44.88272867,\n \"currency\": \"ape\"\n },\n {\n \"minDeposit\": 27.75185426,\n \"minWithdrawal\": 27.75185426,\n \"currency\": \"arbarb\"\n },\n {\n \"minDeposit\": 83.25556278,\n \"minWithdrawal\": 83.25556278,\n \"currency\": \"arberc\"\n },\n {\n \"minDeposit\": 278.07955042,\n \"minWithdrawal\": 278.07955042,\n \"currency\": \"ardr\"\n },\n {\n \"minDeposit\": 27.89654364,\n \"minWithdrawal\": 13.94827182,\n \"currency\": \"arkm\"\n },\n {\n \"minDeposit\": 730.01441973,\n \"minWithdrawal\": 851.68348969,\n \"currency\": \"arpa\"\n },\n {\n \"minDeposit\": 0.43362807,\n \"minWithdrawal\": 0.43362807,\n \"currency\": \"avax\"\n },\n {\n \"minDeposit\": 0.180317,\n \"minWithdrawal\": 0.18067836,\n \"currency\": \"avaxc\"\n },\n {\n \"minDeposit\": 6.64593896,\n \"minWithdrawal\": 5.81519659,\n \"currency\": \"axs\"\n },\n {\n \"minDeposit\": 15.64169921,\n \"minWithdrawal\": 13.68648681,\n \"currency\": \"bal\"\n },\n {\n \"minDeposit\": 201.7624521,\n \"minWithdrawal\": 176.54214559,\n \"currency\": \"bat\"\n },\n {\n \"minDeposit\": 0.03792893,\n \"minWithdrawal\": 0.03792893,\n \"currency\": \"bch\"\n },\n {\n \"minDeposit\": 262.34628671,\n \"minWithdrawal\": 183.6424007,\n \"currency\": \"blur\"\n },\n {\n \"minDeposit\": 0.00862066,\n \"minWithdrawal\": 0.00862066,\n \"currency\": \"bnbbsc\"\n },\n {\n \"minDeposit\": 84.32147762,\n \"minWithdrawal\": 59.02503433,\n \"currency\": \"bnt\"\n },\n {\n \"minDeposit\": 21.79527368,\n \"minWithdrawal\": 10.89763684,\n \"currency\": \"bonderc\"\n },\n {\n \"minDeposit\": 46331.34070624,\n \"minWithdrawal\": 46331.34070624,\n \"currency\": \"bonksol\"\n },\n {\n \"minDeposit\": 0.26627192,\n \"minWithdrawal\": 0.22189326,\n \"currency\": \"bsv\"\n },\n {\n \"minDeposit\": 0.00029608,\n \"minWithdrawal\": 0.00007402,\n \"currency\": \"btc\"\n },\n {\n \"minDeposit\": 17027983.36864314,\n \"minWithdrawal\": 39731961.19350067,\n \"currency\": \"btt\"\n },\n {\n \"minDeposit\": 6.13474063,\n \"minWithdrawal\": 7.66842578,\n \"currency\": \"cake\"\n },\n {\n \"minDeposit\": 132.29766347,\n \"minWithdrawal\": 66.14883173,\n \"currency\": \"chrbsc\"\n },\n {\n \"minDeposit\": 220.49610579,\n \"minWithdrawal\": 154.34727405,\n \"currency\": \"chrerc\"\n },\n {\n \"minDeposit\": 573.26983908,\n \"minWithdrawal\": 501.6111092,\n \"currency\": \"chz\"\n },\n {\n \"minDeposit\": 0.983066,\n \"minWithdrawal\": 0.6881462,\n \"currency\": \"comp\"\n },\n {\n \"minDeposit\": 220.82751221,\n \"minWithdrawal\": 220.82751221,\n \"currency\": \"cro\"\n },\n {\n \"minDeposit\": 187.28143797,\n \"minWithdrawal\": 131.09700658,\n \"currency\": \"crv\"\n },\n {\n \"minDeposit\": 29.96461288,\n \"minWithdrawal\": 34.95871502,\n \"currency\": \"dai\"\n },\n {\n \"minDeposit\": 19.97640858,\n \"minWithdrawal\": 19.97640858,\n \"currency\": \"daipolygon\"\n },\n {\n \"minDeposit\": 0.44803024,\n \"minWithdrawal\": 1.30675488,\n \"currency\": \"dash\"\n },\n {\n \"minDeposit\": 1597.63403757,\n \"minWithdrawal\": 4659.76594291,\n \"currency\": \"dgb\"\n },\n {\n \"minDeposit\": 92.75262358,\n \"minWithdrawal\": 154.58770597,\n \"currency\": \"dodobsc\"\n },\n {\n \"minDeposit\": 386.46926494,\n \"minWithdrawal\": 270.52848546,\n \"currency\": \"dodoerc\"\n },\n {\n \"minDeposit\": 9.92038386,\n \"minWithdrawal\": 15.26212902,\n \"currency\": \"doge\"\n },\n {\n \"minDeposit\": 2.07997653,\n \"minWithdrawal\": 0.86665688,\n \"currency\": \"dot\"\n },\n {\n \"minDeposit\": 85.84862103,\n \"minWithdrawal\": 27.31547032,\n \"currency\": \"dydx\"\n },\n {\n \"minDeposit\": 0.15261886,\n \"minWithdrawal\": 1.07047302,\n \"currency\": \"egld\"\n },\n {\n \"minDeposit\": 1.88188066,\n \"minWithdrawal\": 1.31731646,\n \"currency\": \"ens\"\n },\n {\n \"minDeposit\": 0.48543222,\n \"minWithdrawal\": 0.220651,\n \"currency\": \"etc\"\n },\n {\n \"minDeposit\": 0.00616495,\n \"minWithdrawal\": 0.00154123,\n \"currency\": \"eth\"\n },\n {\n \"minDeposit\": 0.00493045,\n \"minWithdrawal\": 0.00493045,\n \"currency\": \"etharb\"\n },\n {\n \"minDeposit\": 0.00369793,\n \"minWithdrawal\": 0.00369793,\n \"currency\": \"ethbase\"\n },\n {\n \"minDeposit\": 0.0046223,\n \"minWithdrawal\": 0.0046223,\n \"currency\": \"ethbsc\"\n },\n {\n \"minDeposit\": 0.00616321,\n \"minWithdrawal\": 0.00616321,\n \"currency\": \"ethop\"\n },\n {\n \"minDeposit\": 284428.65614537,\n \"minWithdrawal\": 199100.05930176,\n \"currency\": \"floki\"\n },\n {\n \"minDeposit\": 111.50030247,\n \"minWithdrawal\": 78.05021173,\n \"currency\": \"ftm\"\n },\n {\n \"minDeposit\": 47.9510571,\n \"minWithdrawal\": 23.97552855,\n \"currency\": \"ftt\"\n },\n {\n \"minDeposit\": 147.29961343,\n \"minWithdrawal\": 103.1097294,\n \"currency\": \"glm\"\n },\n {\n \"minDeposit\": 79.07324955,\n \"minWithdrawal\": 79.07324955,\n \"currency\": \"gmt\"\n },\n {\n \"minDeposit\": 0.23366977,\n \"minWithdrawal\": 0.16356883,\n \"currency\": \"gno\"\n },\n {\n \"minDeposit\": 255.559094,\n \"minWithdrawal\": 178.8913658,\n \"currency\": \"grt\"\n },\n {\n \"minDeposit\": 173.97653665,\n \"minWithdrawal\": 173.97653665,\n \"currency\": \"hbar\"\n },\n {\n \"minDeposit\": 0.48555226,\n \"minWithdrawal\": 0.48555226,\n \"currency\": \"injbsc\"\n },\n {\n \"minDeposit\": 1259.34232021,\n \"minWithdrawal\": 629.6711601,\n \"currency\": \"jasmyerc\"\n },\n {\n \"minDeposit\": 508.67429772,\n \"minWithdrawal\": 508.67429772,\n \"currency\": \"jsttrc20\"\n },\n {\n \"minDeposit\": 10.65834697,\n \"minWithdrawal\": 10.65834697,\n \"currency\": \"jupsol\"\n },\n {\n \"minDeposit\": 9278.21766773,\n \"minWithdrawal\": 6494.75236741,\n \"currency\": \"key\"\n },\n {\n \"minDeposit\": 91.59261929,\n \"minWithdrawal\": 64.1148335,\n \"currency\": \"knc\"\n },\n {\n \"minDeposit\": 25.0053203,\n \"minWithdrawal\": 12.50266015,\n \"currency\": \"ldoerc\"\n },\n {\n \"minDeposit\": 2.21798445,\n \"minWithdrawal\": 2.21798445,\n \"currency\": \"link\"\n },\n {\n \"minDeposit\": 1792.59026276,\n \"minWithdrawal\": 1140.73925812,\n \"currency\": \"loom\"\n },\n {\n \"minDeposit\": 324.73336072,\n \"minWithdrawal\": 227.3133525,\n \"currency\": \"lrc\"\n },\n {\n \"minDeposit\": 0.01541323,\n \"minWithdrawal\": 0.07006014,\n \"currency\": \"ltc\"\n },\n {\n \"minDeposit\": 144.7099613,\n \"minWithdrawal\": 101.29697291,\n \"currency\": \"mana\"\n },\n {\n \"minDeposit\": 21.33833281,\n \"minWithdrawal\": 14.93683297,\n \"currency\": \"maskerc\"\n },\n {\n \"minDeposit\": 38.6273914,\n \"minWithdrawal\": 28.97054355,\n \"currency\": \"matic\"\n },\n {\n \"minDeposit\": 9.63753415,\n \"minWithdrawal\": 9.65684785,\n \"currency\": \"maticbsc\"\n },\n {\n \"minDeposit\": 1386.48462244,\n \"minWithdrawal\": 924.32308163,\n \"currency\": \"mdxbsc\"\n },\n {\n \"minDeposit\": 1.01948142,\n \"minWithdrawal\": 0.71363699,\n \"currency\": \"metiserc\"\n },\n {\n \"minDeposit\": 0.01908428,\n \"minWithdrawal\": 0.01335899,\n \"currency\": \"mkr\"\n },\n {\n \"minDeposit\": 5.19943942,\n \"minWithdrawal\": 36.46901402,\n \"currency\": \"nano\"\n },\n {\n \"minDeposit\": 3.59445719,\n \"minWithdrawal\": 3.59445719,\n \"currency\": \"near\"\n },\n {\n \"minDeposit\": 42.41731546,\n \"minWithdrawal\": 29.69212082,\n \"currency\": \"nexo\"\n },\n {\n \"minDeposit\": 3516.61768719,\n \"minWithdrawal\": 24665.65512062,\n \"currency\": \"nim\"\n },\n {\n \"minDeposit\": 803.10875859,\n \"minWithdrawal\": 803.10875859,\n \"currency\": \"notton\"\n },\n {\n \"minDeposit\": 11.58909663,\n \"minWithdrawal\": 11.58909663,\n \"currency\": \"op\"\n },\n {\n \"minDeposit\": 49.94091177,\n \"minWithdrawal\": 34.95863824,\n \"currency\": \"pax\"\n },\n {\n \"minDeposit\": 0.02083994,\n \"minWithdrawal\": 0.01458796,\n \"currency\": \"paxgerc\"\n },\n {\n \"minDeposit\": 5079533.98678652,\n \"minWithdrawal\": 5079533.98678652,\n \"currency\": \"pepeerc\"\n },\n {\n \"minDeposit\": 9.63753415,\n \"minWithdrawal\": 9.65684785,\n \"currency\": \"polygon\"\n },\n {\n \"minDeposit\": 0.69274446,\n \"minWithdrawal\": 0.48492112,\n \"currency\": \"qnt\"\n },\n {\n \"minDeposit\": 5.47583695,\n \"minWithdrawal\": 5.47583695,\n \"currency\": \"qtum\"\n },\n {\n \"minDeposit\": 175631.84383254,\n \"minWithdrawal\": 117087.89588836,\n \"currency\": \"racabsc\"\n },\n {\n \"minDeposit\": 716.10242782,\n \"minWithdrawal\": 417.72641622,\n \"currency\": \"rareerc\"\n },\n {\n \"minDeposit\": 5.07671997,\n \"minWithdrawal\": 5.07671997,\n \"currency\": \"ray\"\n },\n {\n \"minDeposit\": 150.11967948,\n \"minWithdrawal\": 105.08377563,\n \"currency\": \"sand\"\n },\n {\n \"minDeposit\": 1.68065718,\n \"minWithdrawal\": 5.05207569,\n \"currency\": \"santosbsc\"\n },\n {\n \"minDeposit\": 6.348705,\n \"minWithdrawal\": 19.08428357,\n \"currency\": \"sfpbsc\"\n },\n {\n \"minDeposit\": 1771232.25460104,\n \"minWithdrawal\": 1771232.25460104,\n \"currency\": \"shib\"\n },\n {\n \"minDeposit\": 4390.83783241,\n \"minWithdrawal\": 1397.08476485,\n \"currency\": \"snt\"\n },\n {\n \"minDeposit\": 29.31265813,\n \"minWithdrawal\": 20.51886069,\n \"currency\": \"snx\"\n },\n {\n \"minDeposit\": 0.02717438,\n \"minWithdrawal\": 0.02717438,\n \"currency\": \"sol\"\n },\n {\n \"minDeposit\": 5231.19747962,\n \"minWithdrawal\": 3661.83823573,\n \"currency\": \"stmxerc\"\n },\n {\n \"minDeposit\": 25.81637731,\n \"minWithdrawal\": 25.81637731,\n \"currency\": \"sui\"\n },\n {\n \"minDeposit\": 1406.99256352,\n \"minWithdrawal\": 1406.99256352,\n \"currency\": \"suntrc20\"\n },\n {\n \"minDeposit\": 68.27264702,\n \"minWithdrawal\": 47.79085291,\n \"currency\": \"super\"\n },\n {\n \"minDeposit\": 287.73689917,\n \"minWithdrawal\": 335.69304903,\n \"currency\": \"sys\"\n },\n {\n \"minDeposit\": 12.38851467,\n \"minWithdrawal\": 12.38851467,\n \"currency\": \"sysevm\"\n },\n {\n \"minDeposit\": 1.67279722,\n \"minWithdrawal\": 1.67279722,\n \"currency\": \"ton\"\n },\n {\n \"minDeposit\": 7.99783679,\n \"minWithdrawal\": 36.35380361,\n \"currency\": \"trx\"\n },\n {\n \"minDeposit\": 49.94091177,\n \"minWithdrawal\": 34.95863824,\n \"currency\": \"tusd\"\n },\n {\n \"minDeposit\": 11.80520722,\n \"minWithdrawal\": 11.80520722,\n \"currency\": \"twtbsc\"\n },\n {\n \"minDeposit\": 43.71553188,\n \"minWithdrawal\": 13.90948741,\n \"currency\": \"uma\"\n },\n {\n \"minDeposit\": 6.59584898,\n \"minWithdrawal\": 4.61709428,\n \"currency\": \"uni\"\n },\n {\n \"minDeposit\": 19.99634119,\n \"minWithdrawal\": 19.99634119,\n \"currency\": \"usdc\"\n },\n {\n \"minDeposit\": 0.99981705,\n \"minWithdrawal\": 4.99908529,\n \"currency\": \"usdcbsc\"\n },\n {\n \"minDeposit\": 1.29976217,\n \"minWithdrawal\": 4.99908529,\n \"currency\": \"usdcpolygon\"\n },\n {\n \"minDeposit\": 1.29976217,\n \"minWithdrawal\": 4.99908529,\n \"currency\": \"usdcsol\"\n },\n {\n \"minDeposit\": 19.99192302,\n \"minWithdrawal\": 3.9983846,\n \"currency\": \"usdt20\"\n },\n {\n \"minDeposit\": 1.29947953,\n \"minWithdrawal\": 2.99879892,\n \"currency\": \"usdtbsc\"\n },\n {\n \"minDeposit\": 10.99688785,\n \"minWithdrawal\": 10.99688785,\n \"currency\": \"usdtpolygon\"\n },\n {\n \"minDeposit\": 4.9979982,\n \"minWithdrawal\": 4.9979982,\n \"currency\": \"usdtsol\"\n },\n {\n \"minDeposit\": 10.98763832,\n \"minWithdrawal\": 10.98763832,\n \"currency\": \"usdtton\"\n },\n {\n \"minDeposit\": 5,\n \"minWithdrawal\": 5,\n \"currency\": \"usdttrc20\"\n },\n {\n \"minDeposit\": 702.29548508,\n \"minWithdrawal\": 702.29548508,\n \"currency\": \"vet\"\n },\n {\n \"minDeposit\": 1514.15212516,\n \"minWithdrawal\": 481.77567618,\n \"currency\": \"vgx\"\n },\n {\n \"minDeposit\": 8539.63685908,\n \"minWithdrawal\": 9962.90966892,\n \"currency\": \"vraerc\"\n },\n {\n \"minDeposit\": 17.09930321,\n \"minWithdrawal\": 8.5496516,\n \"currency\": \"wld\"\n },\n {\n \"minDeposit\": 5.12979096,\n \"minWithdrawal\": 5.12979096,\n \"currency\": \"wldop\"\n },\n {\n \"minDeposit\": 206.33867296,\n \"minWithdrawal\": 180.54633884,\n \"currency\": \"wooerc\"\n },\n {\n \"minDeposit\": 102.72970016,\n \"minWithdrawal\": 102.72970016,\n \"currency\": \"xlm\"\n },\n {\n \"minDeposit\": 0.07423672,\n \"minWithdrawal\": 0.07423672,\n \"currency\": \"xmr\"\n },\n {\n \"minDeposit\": 3.27996097,\n \"minWithdrawal\": 11.47986341,\n \"currency\": \"xrp\"\n },\n {\n \"minDeposit\": 13.56937643,\n \"minWithdrawal\": 14.21553721,\n \"currency\": \"xtz\"\n },\n {\n \"minDeposit\": 0.00866356,\n \"minWithdrawal\": 0.00606449,\n \"currency\": \"yfi\"\n },\n {\n \"minDeposit\": 0.00346542,\n \"minWithdrawal\": 0.00346542,\n \"currency\": \"yfibsc\"\n },\n {\n \"minDeposit\": 0.38365324,\n \"minWithdrawal\": 1.11898864,\n \"currency\": \"zec\"\n },\n {\n \"minDeposit\": 1162.06356574,\n \"minWithdrawal\": 1162.06356574,\n \"currency\": \"zilbsc\"\n },\n {\n \"minDeposit\": 132.58818538,\n \"minWithdrawal\": 92.81172976,\n \"currency\": \"zrx\"\n }\n]"}],"_postman_id":"d8dae306-0798-4c8b-880b-209a9a258345"},{"name":"Supported currencies","event":[{"listen":"prerequest","script":{"id":"b28e39f5-7994-4d39-a310-acd301378e91","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret')"," ? pm.environment.get('api-secret')"," : pm.variables.has('api-secret')"," ? pm.variables.get('api-secret')"," : pm.globals.has('api-secret')"," ? pm.globals.get('api-secret')"," : pm.collectionVariables.has('api-secret')"," ? pm.collectionVariables.get('api-secret')"," : console.error(new Error('api-secret is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","console.log('payload', payload);","","const sign = crypto.HmacSHA512(payload, secret).toString();","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"0fa06254-afcf-40d4-84f1-bcc7ffa5d7f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.heropayments.io/v2/currencies","description":"You can get the list of available currencies either via our V2 \"Supported currencies\" method or via our public document - \"Supported currencies\".
\n","urlObject":{"protocol":"https","path":["v2","currencies"],"host":["api","heropayments","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"0fa06254-afcf-40d4-84f1-bcc7ffa5d7f7"}],"id":"dc43dc71-8479-422d-8dde-c15ebd67ba0b","_postman_id":"dc43dc71-8479-422d-8dde-c15ebd67ba0b","description":""},{"name":"Create a deposit/withdrawal","item":[{"name":"Create a deposit (Custody)","event":[{"listen":"prerequest","script":{"id":"225af2a1-e643-4d77-b3d1-7fbad6218ec8","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret-custody')"," ? pm.environment.get('api-secret-custody')"," : pm.variables.has('api-secret-custody')"," ? pm.variables.get('api-secret-custody')"," : pm.globals.has('api-secret-custody')"," ? pm.globals.get('api-secret-custody')"," : pm.collectionVariables.has('api-secret-custody')"," ? pm.collectionVariables.get('api-secret-custody')"," : console.error(new Error('api-secret-custody is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","const sign = crypto.HmacSHA512(payload, secret).toString();","// console.log(secret, sign);","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"20b9f2a0-936b-4909-980f-9b7ca72ed6c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"currency\": \"trx\",\n \"customerId\": \"new_test_user\",\n \"externalOrderId\": \"merchant_order_id_1\",\n \"callbackUrl\": \"https://webhook.site/your_callback_url\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/custody/deposit","description":"Use this method to create a deposit transaction. Please provide your data as a JSON-object payload.
\nRequest fields:
\ncurrency (required) - the cryptocurrency for deposit specified by the user from the currency list;
\ncustomerId (required) - the Merchant provides an ID that is associated with a particular user of the platform;
\nexternalOrderId (required) - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\ncallbackUrl (optional) - HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries.
\nResponse fields:
\nid - payment ID;
\nsubEmail - if a payment was created by a subuser of the main account, the field reflects the name of the subaccount;
\ncurrency - user's account currency: fiat or cryptocurrency (ex. USD, EUR, BTC, etc.);
\namount - paid amount;
\nfeePercent - Heropayments processing fee (%);
\nfeeAmount - Heropayments processing fee in the Currency equivalent;
\nclientAmount - amount to be credited to the user’s account;
\nmerchantAmount - amount credited to Merchant’s wallet in Currency;
\nnetworkFee - network fee deducted for processing the blockchain transaction. Estimated in a payment currency equivalent;
\ncustomerId - the merchant provides an ID that is associated with a particular user of the platform;
\nexternalOrderId - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\nsequence - helps to differentiate between the subsequent payments. Please read multiple deposit processing;
\ncallbackUrl - HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries;
\ntransactionType - always deposit or withdrawal, in this case deposit;
\naddress - deposit address for crypto assets;
\nconfirmations - number of confirmations on the blockchain. We need to wait until the payment gets at least several confirmations to process it;
\nhash - deposit hash;
\nhashLink - link to deposit hash;
\ncomment - additional information about the deposit;
\ncreatedAt - time, when the deposit was created;
\nupdatedAt - time, when the deposit was updated.
\nYou can check the status of the payment via GET \"Payment status check by id (Custody)\"
\n","urlObject":{"protocol":"https","path":["custody","deposit"],"host":["api","heropayments","io"],"query":[],"variable":[]}},"response":[{"id":"75c6ed9a-3939-4513-a95b-0406fc74a20f","name":"Create deposit","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"usdtbsc\",\n \"customerId\": \"test_user\",\n \"externalOrderId\": \"Test_deposit\",\n \"callbackUrl\": \"https://webhook.site/07e09722-fc19-4d0d-b81f-f536a8c\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/custody/deposit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 21 Oct 2023 19:30:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"x-request-id","value":"02f2544b06ee4681a3701d12cc734db0"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=dB47eyPDpR8wV3FYjrMlRWOi%2FJaq1av%2BvOxhav7HlzUz1959nI3OVDg%2BRFxZkiwN4KfU3hozt4e021D9wEaOr6t4DkRzifv9pXdiUftfuOKuXoABGNUvNWwcvwmiTXJ6tK%2B46SWxnttahq1q\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"819be9e37d237fd9-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"f3748917-d4ae-4dae-bec1-c00e269be9\",\n \"subEmail\": null,\n \"currency\": \"usdtbsc\",\n \"amount\": \"4\",\n \"feePercent\": 0.5,\n \"feeAmount\": \"0.02\",\n \"clientAmount\": \"4\",\n \"merchantAmount\": \"3.68\",\n \"networkFee\": \"0.3\",\n \"customerId\": \"test_user\",\n \"externalOrderId\": \"Test_deposit\",\n \"sequence\": \"original\",\n \"callbackUrl\": \"https://webhook.site/07e09722-fc19-4d0d-b81f-f536a8c\",\n \"transactionType\": \"deposit\",\n \"address\": \"0xfc9ca35f6296cadfc5f95145acd55abfd0eaf\",\n \"addressExtra\": null,\n \"status\": \"finished\",\n \"confirmations\": 23,\n \"hash\": \"0xc81b15173d536f5063ec4c11cfd7aa5cfbfd668ac2433d175efea100bfd25\",\n \"hashLink\": \"https://bscscan.com/tx/0xc81b15173d536f5063ec4c11cfd7aa5cfbfd668ac2433d175efea100bfd25\",\n \"comment\": null,\n \"createdAt\": \"2025-03-13T14:16:53.315Z\",\n \"updatedAt\": \"2025-03-13T14:21:22.163Z\"\n}"}],"_postman_id":"20b9f2a0-936b-4909-980f-9b7ca72ed6c8"},{"name":"Create a withdrawal (Custody)","event":[{"listen":"prerequest","script":{"id":"225af2a1-e643-4d77-b3d1-7fbad6218ec8","exec":["const crypto = require('crypto-js');","","let payload = '';","","const secret = pm.environment.has('api-secret-custody')"," ? pm.environment.get('api-secret-custody')"," : pm.variables.has('api-secret-custody')"," ? pm.variables.get('api-secret-custody')"," : pm.globals.has('api-secret-custody')"," ? pm.globals.get('api-secret-custody')"," : pm.collectionVariables.has('api-secret-custody')"," ? pm.collectionVariables.get('api-secret-custody')"," : console.error(new Error('api-secret-custody is missing'));","","try {"," switch (pm.request.method) {"," case 'POST': "," payload = JSON.stringify(JSON.parse(pm.request.body.toString()));"," break;"," case 'GET':"," payload = pm.request.url.query.toString();"," break;"," }","} catch {"," console.error(new Error('Cant decode JSON body'))","}","const sign = crypto.HmacSHA512(payload, secret).toString();","// console.log(secret, sign);","pm.request.headers.upsert({"," key: 'x-api-sign',"," value: sign,","});"],"type":"text/javascript","packages":{}}}],"id":"bb5ca6c4-abbe-4bc3-b2ff-4f7425cac02a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"usdtbsc\",\n \"address\": \"0x3e53A2FD8B63599B92A19458d4B01a5D74BCd125\",\n \"currency\": \"usdtbsc\",\n \"amount\": \"6\",\n \"callbackUrl\": \"https://example.com/callback\",\n \"externalOrderId\": \"100500\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/custody/withdrawal","description":"Use this method to create a withdrawal (payout) transaction. Please provide your data as a JSON-object payload.
\nRequest fields:
\namount (required) - the amount that the user will receive;
\ne-mail (optional) - user’s email address;
\naddress (required) - your user’s address to receive the withdrawal;
\naddressExtra (optional) - additional Id which is necessary for identifying a recipient of the transaction. Also known as additional address, memo or destination tag. Users must enter it while withdrawing XRP, BNB, XLM and some other currencies;
\ncurrency (required) - cryptocurrency of a withdrawal specified by the user from a supported currency list;
\ncustomerId (required) - the merchant provides an ID that is associated with a particular user of the platform;
\nexternalOrderId (required) - merchant's custom order ID. Example: BGBRB-30020. This ID must be unique to create a transaction;
\ncallbackUrl (optional) - HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries.
\nResponse fields:
\nid – payment ID;
\nsubEmail - if a payment was created by a subuser of the main account, the field reflects the name of the subaccount;
\ncurrency - cryptocurrency of the withdrawal specified by the the user from a supported currency list;
\namount - amount requested for the withdrawal;
\nfeePercent - Heropayments processing fee (%);
\nfeeAmount - Heropayments fee deducted for a transaction in a payment currency equivalent;
\nclientAmount - amount sent to the user;
\nmerchantAmount - amount deducted from Merchant's balance to process the withdrawal for the user;
\nnetworkFee - network fee deducted for processing the blockchain transaction;
\ncustomerId - the merchant provides an ID that is associated with a particular user of the platform;
\nexternalOrderId - merchant's custom order ID. Example: BGBRB-30020;
\ncallbackUrl - HTTP(s) URL of your server which will accept callback requests. Heropayments will send callbacks whenever the status of a transaction gets an update. If your server is inaccessible or cannot accept a callback request, our system will try to send it again until it reaches the limit of five retries;
\ntransactionType - always deposit or withdrawal, in this case withdrawal;
\naddress - destination address of your user where the crypto was withdrawn to;
\naddressExtra - additional Id which is necessary for identifying a recipient of the transaction. Also known as additional address, memo or destination tag. Users must enter it while withdrawing XRP, BNB, XLM and some other currencies;
\nstatus - status of the payment;
\nconfirmations - valid only for deposit transactions;
\nhash - withdrawal hash;
\nhashLink - link to withdrawal hash;
\ncomment - additional information about the payment;
\ncreatedAt - time, when the withdrawal was created;
\nupdatedAt - time, when the withdrawal was updated.
\nYou can check the status of the payment via GET \"Payment status check by id (Custody)\"
\nWe have 2 types of daily limits:
\nMerchant withdrawal limit – for the entire merchant account per day
\nCustomer withdrawal limit – for each customerId per day
\nTo set up the limits, reach us via partners@heropayments.io or contact your personal account manager.
\n","urlObject":{"protocol":"https","path":["custody","withdrawal"],"host":["api","heropayments","io"],"query":[],"variable":[]}},"response":[{"id":"eb61e40e-b275-4036-a990-45ec2bf1f45e","name":"Create withdrawal","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"},{"key":"x-api-sign","value":"calculated_sign_for_query_string","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"test_user\",\n \"address\": \"0xDABBe153ae4DfaA7A40Aed87AB58ca2f91ef436e\",\n \"amount\": \"4\",\n \"currency\": \"usdtbsc\",\n \"callbackUrl\": \"https://webhook.site/07e09722-fc19-4d0d-b81f-f536a8c\",\n \"externalOrderId\": \"Test_withdrawal\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/custody/withdrawal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 21 Oct 2023 19:52:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"x-request-id","value":"698c90245c4bad3b7f12f10c44ad779c"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=wsqWgcSq0byZeiSc%2FKCac4U8kB%2BNXYhziKpeUJXLPyZSwBY0xPmJhI4evhaCi6KMBOGPe75LXSAO8CwsLozY%2B%2BEXjhEdwufZ4LKaVt%2FxR453z0d%2FFAqhelQLC8%2BWEDMwJlNEqNJ6EgG8jFXr\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"819c09f9fe5b3b18-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9adb774a-75d5-4af5-8f6b-eb562d54f4db\",\n \"subEmail\": null,\n \"currency\": \"usdtbsc\",\n \"feePercent\": 0.5,\n \"amount\": \"4\",\n \"feeAmount\": \"0.02\",\n \"clientAmount\": \"4\",\n \"merchantAmount\": \"4.32\",\n \"networkFee\": \"0.3\",\n \"customerId\": \"test_user\",\n \"externalOrderId\": \"Test_withdrawal\",\n \"callbackUrl\": \"https://webhook.site/07e09722-fc19-4d0d-b81f-f536a8c\",\n \"transactionType\": \"withdrawal\",\n \"address\": \"0xDABBe153ae4DfaA7A40Aed87AB58ca2f91ef436e\",\n \"addressExtra\": \"\",\n \"status\": \"finished\",\n \"confirmations\": 0,\n \"hash\": \"0xa32ba5f98d490036fb1f37c2eb637ec77103e10b5e7f761bd28017dbc22608\",\n \"hashLink\": \"https://bscscan.com/tx/0xa32ba5f98d490036fb1f37c2eb637ec77103e10b5e7f761bd28017dbc22608\",\n \"createdAt\": \"2025-07-23T11:15:59.992Z\",\n \"updatedAt\": \"2025-07-23T11:16:50.884Z\"\n}"}],"_postman_id":"bb5ca6c4-abbe-4bc3-b2ff-4f7425cac02a"}],"id":"68655087-bc7f-480b-9ea6-c0c52e876329","_postman_id":"68655087-bc7f-480b-9ea6-c0c52e876329","description":""}],"id":"b27249a7-417e-4b4a-84ef-c17bdb019652","_postman_id":"b27249a7-417e-4b4a-84ef-c17bdb019652","description":""}],"event":[{"listen":"prerequest","script":{"id":"b46d84ea-c0ba-48bd-b727-24aa6b8f82b5","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"7565182f-6005-40ee-a9df-036a728b0852","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"api-secret","value":"your_api_secret"},{"key":"x-api-key","value":"your_api_key"},{"key":"api-secret-custody","value":"your_api_secret_custody"},{"key":"api-key-custody","value":"your_api_key_custody"},{"key":"prod","value":""}]}