Heropayments is a non-custodial cryptocurrency payment gateway. We provide an infrastructure for online businesses to accept payments in 100+ crypto assets and convert them into stable coin BUSD Binance Smart Chain (bep-20).
\nTo use the Heropayments API you should do the following:
\nGets all available crypto currencies to use for customer payments.
\n","urlObject":{"path":["currencies"],"host":["https://api.heropayments.io/v1"],"query":[],"variable":[]}},"response":[{"id":"828be98a-bf54-4d63-9190-0bd951ca9690","name":"200 OK","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://api.heropayments.io/v1/currencies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"ticker\": \"btc\",\n \"fullName\":\"Bitcoin\",\n \"extraIdName\": null,\n \"isStable\": false,\n \"confirmations\": 1\n },\n {\n \"ticker\": \"eth\",\n \"fullName\": \"Ethereum\",\n \"extraIdName\": null,\n \"isStable\": false,\n \"confirmations\": 3\n },\n {\n \"ticker\": \"usdc\",\n \"fullName\": \"USD Coin\",\n \"extraIdName\": null,\n \"isStable\": false,\n \"confirmations\": 3\n },\n {\n \"ticker\": \"xrp\",\n \"fullName\": \"XRP\",\n \"extraIdName\": \"Destination tag\",\n \"isStable\": false,\n \"confirmations\": 1\n }\n]"}],"_postman_id":"3d017da7-90f9-457b-b660-30902faa9b19"},{"name":"Create invoice","id":"8a324133-ca08-4273-9764-52709d828dc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"Creates an invoice.
\nWith this method, the customer is required to follow the generated url (invoiceUrl) to start the payment procedure, where he can see the payment amount, select the desired payment currency and complete the payment.
\nRequest payload fields:
\npriceAmount - The price set by the merchant which will converted to an equal amount of a chosen cryptocurrency.
priceCurrency - the fiat currency in which the priceAmount is specified and displayed (usd, eur).
customerId (optional) - Merchant provides an id that is associated with a particular customer for the invoice and its following payments. it can be an email, a phone number or any other kind of information. (string)
orderId (optional) - Merchant's custom order ID. Example: RGBPV-12345.
orderDescription (optional) - More details about this order. It can be cart items, product details or other information. Example: 1 x Apple iPhone 13, 1 x Apple MacBook Pro 2020.
successUrl (optional) - Redirect to Merchant's URL after successful payment (thank-you page).
failUrl (optional) - Redirect to Merchant's URL when a customer cancels the order (cancel page).
Gets invoice by id.
\n","urlObject":{"path":["invoices",":id"],"host":["https://api.heropayments.io/v1"],"query":[],"variable":[{"description":{"content":"invoice id
\n","type":"text/plain"},"type":"any","value":"Gets current conversion rate from crypto to fiat.
\nYou will need to provide the initial amount in a fiat currency (priceAmount, priceCurrency) and a necessary cryptocurrency (payCurrency).
\nCurrently following fiat currencies are available: usd, eur.
\nRequest payload fields:
\npriceCurrency - fiat currency.
payCurrency - crypto currency.
priceAmount - fiat currency amount (order price).
Response fields:
\npriceCurrency
payCurrency
priceAmount
payAmount - crypto amount to pay for customer.
minAmount - minimal amount that can be processed by Heropayments for a given currency.
maxAmount - maximum amount that can be processed by Heropayments for a given currency.
Creates new payment for specified invoice.
\nRequest payload fields:
\nResponse fields:
\n| waiting | \nwaiting for customer payment | \n
| confirming | \npayment has just received | \n
| exchanging | \nmoney is in converting phase | \n
| sending | \nmoney is in sending phase on merchant wallet | \n
| finished | \nmoney should be received on merchant wallet | \n
| partially_paid | \nmoney received, but the amount is under underpayment threshold | \n
| failed | \nsomething went wrong | \n
| hold | \nAML system triggered, the payment is on hold | \n
Note: email is not exposed here since it's used only for sending final receipt to the customer after successful payment.
\n","urlObject":{"path":["payments"],"host":["https://api.heropayments.io/v1"],"query":[],"variable":[]}},"response":[{"id":"335d5462-0bf3-41f7-9e34-00140074b809","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invoiceId\": \"11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000\",\n \"payCurrency\": \"eth\",\n \"email\": \"mike.d@gmail.com\",\n \"userNotes\": \"available for a call at 6pm\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heropayments.io/v1/payments"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"waiting\",\n \"invoice\": {\n \"id\": \"11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000\",\n \"orderId\": \"10000583\",\n \"orderDescription\": \"Online courses access\",\n \"priceCurrency\": \"usd\",\n \"priceAmount\": \"40\"\n },\n \"payCurrency\": \"eth\",\n \"payAmount\": \"0.05\",\n \"payAddress\": \"0x6cc8dcbc0746a6e4fdefb98e1d0df903b107fd21\",\n \"userNotes\": \"available for a call at 6pm\",\n \"createdAt\": \"2021-09-15T10:24:09.450Z\",\n \"paidAmount\": null,\n \"paid\": false\n}"}],"_postman_id":"be519b3d-624f-46a9-bf1b-0a722d9d01f4"},{"name":"Query payments","id":"f49e71f0-4ccf-4750-8828-c474e8b9632c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"Queries payments list by specified filters.
\n","urlObject":{"path":["payments"],"host":["https://api.heropayments.io/v1"],"query":[{"description":{"content":"useful for server pagination (50 as maximum value)
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"useful for server pagination (0 is default value)
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"invoice id
\n","type":"text/plain"},"key":"invoiceId","value":"order id from merchant
\n","type":"text/plain"},"key":"orderId","value":"status
\n","type":"text/plain"},"key":"status","value":"fiat
\n","type":"text/plain"},"key":"priceCurrency","value":"crypto
\n","type":"text/plain"},"key":"payCurrency","value":"date from (ISO)
\n","type":"text/plain"},"key":"dateFrom","value":"date to (ISO)
\n","type":"text/plain"},"key":"dateTo","value":"incoming crypto payment hash
\n","type":"text/plain"},"key":"payHash","value":"payment crypto address
\n","type":"text/plain"},"key":"payAddress","value":"Gets payment by payment id.
\nNOTE! You should make the get payment status request with the same API key that you used in the create payment request. Here is the list of avalable statuses:
\nHere the list of available statuses of the payments:
\nwaiting - waiting for the customer to send the payment. The initial status of each payment.
\nconfirming - the transaction is being processed on the blockchain. Appears when Heropayments detect the funds from the user on the blockchain.
\nconfirmed - the process is confirmed by the blockchain. Customer’s funds have accumulated enough confirmations.
\nsending - the funds are being sent to your personal wallet. We are in the process of sending the funds to you.
\nfinished - the funds have reached your personal address and the payment is finished.
\nfailed - the payment wasn't completed due to the error of some kind.
\nrefunded - the funds were refunded back to the user.
\nexpired - the user didn't send the funds to the specified address in the 1 hour time window.\"
\n","urlObject":{"path":["payments",":id"],"host":["https://api.heropayments.io/v1"],"query":[],"variable":[{"type":"any","value":null,"key":"id"}]}},"response":[{"id":"9cacc7bd-95ca-45de-88e1-8a052cb9fc55","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.heropayments.io/v1/payments/:id","host":["https://api.heropayments.io/v1"],"path":["payments",":id"],"variable":[{"key":"id","value":null}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"confirming\",\n \"invoice\": {\n \"id\": \"11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000\",\n \"orderId\": \"10000583\",\n \"orderDescription\": \"Online courses access\",\n \"priceCurrency\": \"usd\",\n \"priceAmount\": \"40\"\n },\n \"priceCurrency\": \"usd\",\n \"priceAmount\": \"40\",\n \"payCurrency\": \"eth\",\n \"payAmount\": \"0.05\",\n \"payAddress\": \"0x6cc8dcbc0746a6e4fdefb98e1d0df903b107fd21\",\n \"userNotes\": \"available for a call at 6pm\",\n \"createdAt\": \"2021-09-15T10:24:09.450Z\",\n \"paidAmount\": \"0.04\",\n \"paid\": true\n}\n"}],"_postman_id":"bd3d6f01-b6b1-4936-a1c2-2bd4638e4482"}],"event":[{"listen":"prerequest","script":{"id":"0b35e2a4-93dc-4d07-977a-ca20439e5bfc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"548868d7-d75d-4b44-9497-b7ffa75eebd9","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.heropayments.io/v1"},{"key":"apiKey","value":"