FaradPay API Docs

FaradPay is the #1 cryptocurrency payment gateway for businesses — secure, instant, and with the lowest fees in the industry.

Secure

Enterprise-grade security with 256-bit encryption and PCI-DSS compliance for all transactions.

Instant

Real-time settlement and confirmation with lightning-fast transaction processing.

Lowest Fees

Maximum profit with industry-best rates starting from just 0.5% per transaction.

API Overview

Our RESTful API is designed to be easy to integrate. Whether you are building an e-commerce store, a crypto exchange, or a custom billing platform, FaradPay provides the tools you need.

With comprehensive documentation, webhook support, and 24/7 technical assistance, you can start accepting cryptocurrency payments in minutes.

Start Accepting Crypto

Create an Account

https://gateway.faradpay.com/register

Response Format

JSON (UTF-8)

Authentication

API Key (Header)

Rate Limits

60 requests/min

Supported Currencies

USDT (BSC) USDT (TRX) USDC (BSC) SUI TRX USDT (POLYGON) BTC ETH

Quick Start Guide

Sign up for a FaradPay merchant account
Generate your API key from the dashboard
Use the API key in the x-api-key header
Make your first API call to create a payment
Handle webhook notifications for payment updates

Need Help?

support@faradpay.com Telegram Support Discord Community GitHub Examples

Post

Recharge

https://faradpay.com/api/payment

Payment API

This endpoint allows you to initiate a payment transaction. You can specify the amount, currency, and other relevant details for the payment.

Request

Method: POST

URL: https://faradpay.com/api/payment

Request Body

The request body must be in JSON format and include the following parameters:

Parameter	Type	Description
priceAmount	number	The amount of money to be paid.
priceCurrency	string	The currency in which the price amount is specified. For example, "USDTBSC", "USDTTRX", "USDCBSC", "SUI", "TRX", "USDTPOLYGON".
payCurrency	string	The currency that will be used for the payment. It should match the `priceCurrency`.
orderId	string	A unique identifier for the order.
orderDescription	string	A description of the order, providing context for the transaction (e.g., "Deposit (Online)").

Response

The response will be in JSON format. It may include the following fields:

Field	Type	Description
status	string	The status of the request.
message	string	A message providing additional information about the request.
errors	array of strings	An array that contains any errors that occurred during the processing of the request.
_meta	object	Metadata about the request, which includes:

_meta object:

statusCode (number): The HTTP status code returned by the server.
timestamp (number): A timestamp indicating when the request was processed.
requestId (string): A unique identifier for the request.
path (string): The path of the request.
method (string): The HTTP method used for the request.
duration (number): The time taken to process the request.
ip (string): The IP address from which the request originated.
userAgent (string): The user agent string of the client making the request.
hostname (string): The hostname of the server processing the request.

Headers

Header	Value
x-api-key	your api key---replace here
Content-Type	application/json
Accept	application/json

Body raw (json)

{
        "priceAmount": 100.0,
        "priceCurrency": "USDTBSC",
        "payCurrency": "USDTBSC",
        "orderId": "ORDER12345",
        "orderDescription": "Deposit (Online)"
    }

Notes:

A status code of 500 indicates an internal server error, which means that something went wrong on the server side while processing the request.
Ensure that all parameters are correctly formatted and valid to avoid errors during the payment process.

Post

Withdrawal

https://faradpay.com/api/payout

Payout API

This endpoint allows users to initiate a payout request for cryptocurrency withdrawals.

Request Method

POST

Endpoint

https://faradpay.com/api/payout

Request Body

The request body must be in JSON format and should contain the following parameters:

Parameter	Type	Description
withdrawals	array	A list of withdrawal objects. Each object must include:

Withdrawal object fields:

address (string): The wallet address where the funds will be sent.
currency (string): The type of cryptocurrency to be withdrawn (e.g., "USDTBTC", "USDTTRX", "USDCBSC", "SUI", "TRX", "USDTPOLYGON").
amount (number): The amount of cryptocurrency to withdraw.
ipnCallbackUrl (string): A URL to which the payment notification will be sent.

Expected Response Format

The response will typically include a status indicating the success or failure of the payout request, along with any relevant transaction details or error messages. Ensure that all parameters are correctly formatted and provided in the request to avoid errors.

Headers

Header	Description
x-api-key	your api key---replace here
Content-Type	application/json
Accept	application/json

Body raw (json)

{
  "withdrawals": [
    {
      "address": "someaddress",
      "currency": "USDTBSC",
      "amount": 1,
      "ipnCallbackUrl": "https://faradpay.com/ap/ipn-handler"
    }
  ]
}

Note:

Ensure that all parameters are correctly formatted and provided in the request to avoid errors.