Finrax API
HomeChangelogIntegration GuideResources
HomeChangelogIntegration GuideResources
  1. Payments and Withdrawals
  • Getting Started
    • Introduction
    • Environments
    • Errors
    • Authorization
      • API Key Management
      • Signature
      • Code Snippets
  • Payments and Withdrawals
    • Crypto Payments
      • Fetch payment by ID
      • 🔒Fetch payments
      • Submit crypto payment
      • Request crypto payment
    • Fetch withdrawals
      GET
    • Fetch withdrawal metadata
      GET
    • Request crypto withdrawal
      POST
    • Fetch whitelisted addresses
      GET
    • Whitelist an address
      POST
    • Fetch crypto withdrawal approval by ID
      GET
    • Fetch business by ID
      GET
    • Fetch business balance
      GET
    • Unwhitelist an address
      DELETE
  • Callbacks
    • Deposit received notification
    • Withdrawal broadcast notification
    • Withdrawal approved/rejected notification
  • Address validation
    • Validate address
      GET
    • Validate address and destination tag
      GET
  • Rates and metadata
    • Fetch market rates
      GET
    • Fetch fiat rates
      GET
    • Fetch deposit rates
      GET
    • Fetch all currencies
      GET
  1. Payments and Withdrawals

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 dimensions when displaying our checkout:
Minimal dimensions for the checkout Iframe- height: 500px; width: 360px;
Optimal dimensions for the checkout Iframe - height: 627px; width: 450px;
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#

StatusDescription
NEWA payment has been created, however, no depositCurrency has been selected yet. (Screen 1 above)
PENDINGCustomer has selected a depositCurrency and is presented with a cryptocurrency deposit address. Finrax listens for blockchain events on the particular wallet address.
AWAITINGThis 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)
DEPOSITEDThe transaction has been completed and your account balance has been updated. A callback notification is triggered to your designated endpoint.
EXPIREDOnce 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.
BLOCKEDThe 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.)
OVERPAIDOnly present if the business has the overpayment logic active. The deposited amount exceeded the expected amount, starting the process of refunding.

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 #

CurrencyNetworkDefault Network
USDCEthereum chain (ETH), Binance Smart Chain (BSC) and Solana network (SPL)Ethereum chain (ETH)
ETHEthereum chain (ETH) and Binance Smart Chain (BSC)Ethereum chain (ETH)
USDTEthereum chain (ETH), Binance Smart Chain (BSC), Tron Chain (TRX) and Solana network (SPL)Ethereum chain (ETH)
SOLSOLSolana network (SPL)
BTCBTCBTC
BCHBCHBCH
LTCLTCLTC
XRPXRPXRP
XLMXLMXLM
LINKETHETH
Modified at 2024-07-09 07:37:37
Previous
Code Snippets
Next
Fetch payment by ID
Built with