Crypto payments
In this section we'll go through the endpoints you'll need to execute crypto payments on your website. You can make use of our hosted checkout experience or spin-off a custom UI.
Guidelines for checkout integration in Iframe
To provide the best user experience, we strongly recommend that you use the following minimum dimensions when displaying our checkout:
Height: 640px
Width: 320px
Our checkout uses the clipboard API to allow users to easily copy the Amounts, Addresses and Transaction ID that are displayed on the screen. This action might be prevented by Chrome and other browsers, so to allow the copying of text with a single button simply add the allow="clipboard-write"
property to your <iframe>
tag.
Payment statuses
Status | Description |
NEW | A payment has been created, however, no depositCurrency has been selected yet. (Screen 1 above) |
PENDING | Customer has selected a depositCurrency and is presented with a cryptocurrency deposit address. Finrax listens for blockchain events on the particular wallet address. |
AWAITING | This is an optional status. It will be skipped if the deposit is eligible for Instant Deposits. This status represents that we've "seen" a transfer on the blockchain, but is still in UNCONFIRMED status. Transaction has not been validated yet on the blockchain (Screen 4 above) |
DEPOSITED | The transaction has been completed and your account balance has been updated. A callback notification is triggered to your designated endpoint. |
EXPIRED | Once the expirationMinutes is reached and no deposit has been received against the supplied wallet address, the payment will be changed to status EXPIRED. Bear in mind that this is a tentative status. If we locate a blockchain transaction after the payment is changed to EXPIRED, we'll update the status from EXPIRED to DEPOSITED and trigger a callback notification. |
BLOCKED | The transaction received against a given payment has been blocked due to compliance reasons. This usually happens if the origin of funds is marked as illicit (i.e. Darknet, Scam , etc.) |
OVERPAID |
Adding side chain support for deposits
To make use of deposits through side chains the payload of either the Request crypto payment or the Add payment details request should be changed, so that it includes the network
field.
If the network field is not included in the request, then we'll use the default network for respective currency. Details for the supported deposit and default deposit networks can be found in the table below.
List of currencies and their supported deposit networks
Currency | Network | Default Network |
---|---|---|
USDC | Ethereum chain (ETH), Binance Smart Chain (BSC) and Solana network (SPL) | Ethereum chain (ETH) |
ETH | Ethereum chain (ETH) and Binance Smart Chain (BSC) | Ethereum chain (ETH) |
SOL | SOL | Solana network (SOL) |
BTC | BTC | BTC |
BCH | BCH | BCH |
LTC | LTC | LTC |
XRP | XRP | XRP |
XLM | XLM | XLM |
LINK | ETH | ETH |
Last updated