Finrax API Documentation
DashboardResourcesMain
  • Introduction
  • Authorization
    • API Keys Management
    • Signature
    • Code snippets
  • Environments
  • Errors
  • Changelog
  • References
    • Crypto payments
      • 🔒Request crypto payment
      • 🔒Add payment details
      • 🔒Get payment data
      • Fetch deposit amounts metadata
    • Crypto withdrawals
      • Request withdrawal metadata
      • 🔓Get crypto withdrawal approval status
      • 🔒Request crypto withdrawal
        • National Identifier Types
        • Name Identifier Type
    • Wallet Addresses
      • Validate address
    • Businesses
      • 🔒Get business payments
      • 🔒Get business withdrawals
      • 🔒Get business balances
    • Callbacks
      • Deposit received notification
      • Withdrawal broadcast notification
      • Withdrawal approved/rejected notification
    • Currencies & Fees
      • Get all currencies
      • Get exchange rates [crypto to fiat]
      • Get exchange rates [fiat to fiat]
      • Get exchange rates [any currency to any currency]
Powered by GitBook
On this page
  • Guidelines for checkout integration in Iframe
  • Payment statuses
  • Adding side chain support for deposits
  • List of currencies and their supported deposit networks

Was this helpful?

  1. References

Crypto payments

PreviousChangelogNextRequest crypto payment

Last updated 14 days ago

Was this helpful?

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 that is only applicable to UTXO deposits. It 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

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

UNPROCESSABLE

This status is related to the following 2 events:

  1. The deposit received was below the minimum deposit amount, so it will not be processed nor credited to the business. This status will not trigger a callback notification.

  2. The deposit was received for an UNPROCESSABLE currency. Currently the only such currency is USDT. The support for it was discontinued for all EU based organisations.

Adding side chain support for deposits

List of currencies and their supported deposit networks

Currency
Supported Networks

USDC

Ethereum chain (ETH), Binance Smart Chain (BSC) and Solana network (SOL)

ETH

Ethereum chain (ETH) and Binance Smart Chain (BSC)

SOL

SOL

BTC

BTC

BCH

BCH

LTC

LTC

XRP

XRP

XLM

XLM

LINK

ETH

The transaction has been completed and your account balance has been updated. A is triggered to your designated endpoint.

Only present if the business has the active. The deposited amount exceeded the expected amount, starting the process of refunding.

To make use of deposits through side chains the payload of either the or the request should be changed, so that it includes the network field.

Request crypto payment
Add payment details
callback notification
overpayment logic