{"info":{"_postman_id":"13857a19-fde0-4a61-bf2e-6774120a004c","name":"API Faradpay","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"46702761","collectionId":"13857a19-fde0-4a61-bf2e-6774120a004c","publishedId":"2sB3BBrXqH","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-05-04T07:22:09.000Z"},"item":[{"name":"Recharge","id":"07b01660-a0a5-4820-85ff-98092f7008b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"name":"cache-control","sortOrder":2,"infoTitle":"We recommend using this header","info":"Postman added \"Cache-Control: no-cache\" as a precautionary measure to prevent the server from returning stale response when one makes repeated requests.\n\nYou can remove this header in the app settings or enter a new one with a different value.","allowedToToggle":false,"disableEdit":true,"previewSettingsLink":"Go to settings","key":"Cache-Control","value":"no-cache","system":true,"type":"text"},{"name":"postman-token","sortOrder":3,"infoTitle":"We recommend using this header","info":"The Postman-Token header appends a random UUID to every outgoing request. Postman adds this header for API developers to better debug requests sent and to ensure separate requests appear distinct to the receiving server.\n\nYou can remove this header in the app settings.","allowedToToggle":false,"disableEdit":true,"previewSettingsLink":"Go to settings","key":"Postman-Token","value":"","system":true,"type":"text"},{"name":"content-type","sortOrder":4,"infoTitle":"This header was automatically added","info":"The Content-Type header is added to help the server identify the media type of the request body that is present in this request.\n\nUse the request body tab to control the value or to remove this header.","allowedToToggle":true,"disableEdit":true,"previewSettingsLink":"Go to body","key":"Content-Type","value":"application/json","system":true,"type":"text"},{"name":"content-length","sortOrder":5,"infoTitle":"This header was automatically added","info":"The Content-Length header was added to indicate to the server the size of the request body that is added to this request. Server uses this value to parse the request body accurately.\n\nYou can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"previewSettingsLink":"Go to body","key":"Content-Length","value":"","system":true,"type":"text"},{"name":"host","sortOrder":6,"infoTitle":"We recommend using this header","info":"The Host header is added to identify the domain name for which a request is being sent to the server. This header is implicitly sent by every HTTP client.\n\nYou can remove the header or enter a new one with a different value. It is most likely that without this header, your request will return an HTTP 400 error.","allowedToToggle":true,"disableEdit":true,"key":"Host","value":"","system":true,"type":"text"},{"name":"user-agent","sortOrder":7,"infoTitle":"We recommend using this header","info":"The User-Agent header is added to help the server identify Postman as the HTTP requesting application or client.\n\nIt is recommended that this header be sent, but you can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"key":"User-Agent","value":"PostmanRuntime/7.39.1","system":true,"type":"text"},{"name":"accept","sortOrder":8,"infoTitle":"We recommend using this header","info":"The \"Accept: */*\" header is added to tell the server that Postman can understand and process all forms of response content types.\n\nIt is recommended that this header be sent, but you can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"key":"Accept","value":"*/*","system":true,"type":"text"},{"name":"accept-encoding","sortOrder":9,"infoTitle":"We recommend using this header","info":"The Accept-Encoding header is added to indicate to the server that Postman HTTP client supports a defined list of content-encoding or compression algorithms as response.\n\nYou can remove the header or enter a new one with a different value. Doing that may not accurately render the response within the app.","allowedToToggle":true,"disableEdit":true,"key":"Accept-Encoding","value":"gzip, deflate, br","system":true,"type":"text"},{"name":"connection","sortOrder":10,"infoTitle":"We recommend using this header","info":"Postman added the Connection header to indicate the server to keep the underlying network connection open once the current response is received. This allows Postman to reuse the same connection for faster response times in subsequent requests to the same server.\n\nYou can remove this header or enter a new one with a different value, such as `Connection: Close` to control this behaviour.","allowedToToggle":true,"disableEdit":true,"key":"Connection","value":"keep-alive","system":true,"type":"text"},{"key":"x-api-key","value":"ABCD123456789000000XXXX","type":"text","id":0},{"key":"Content-Type","value":"application/json","type":"text","id":1},{"key":"Accept","value":"application/json","type":"text","id":2}],"body":{"mode":"raw","raw":"{\r\n \"priceAmount\": 15.0,\r\n \"priceCurrency\": \"USDTBSC\",\r\n \"payCurrency\": \"USDTBSC\",\r\n \"network\": \"bsc\",\r\n \"orderId\": \"ORDER1010101\",\r\n \"orderDescription\": \"Deposit (Online)\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://gateway.faradpay.com/api/payment","description":"

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://gateway.faradpay.com/api/payment

Request Body

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

priceAmount (number): The amount of money to be paid.
priceCurrency (string): The currency in which the price amount is specified. For example, \"USDTBSC\".
payCurrency (string): The currency that will be used for the payment. It should match the priceCurrency.
network (string): The network through which the payment will be processed (e.g., \"bsc\").
orderId (string): A unique identifier for the order.
orderDescription (string): A description of the order, providing context for the transaction (e.g., \"Deposit (Online)\").

Example Request Body

{\n  \"priceAmount\": 100,\n  \"priceCurrency\": \"USDTBSC\",\n  \"payCurrency\": \"USDTBSC\",\n  \"network\": \"bsc\",\n  \"orderId\": \"ORDER12345\",\n  \"orderDescription\": \"Deposit (Online)\"\n}\n\n

//Example Request Body CallBackRechargeResponse\n{\n    \"payment_id\": \"pay_f3f0f904edd71314d6dc3f4f46c247b7\",\n    \"payment_status\": \"finished\",\n    \"pay_address\": \"0x123456789xxxxxx\",\n    \"price_amount\": \"100\",\n    \"price_currency\": \"USDTBSC\",\n    \"pay_amount\": \"100\",\n    \"pay_currency\": \"USDTBSC\",\n    \"amount_received\": \"100\",\n    \"order_id\": \"ORDER12345\",\n    \"created_at\": \"2025-08-06 09:59:42\",\n    \"updated_at\": \"2025-08-06 10:10:00\",\n    \"purchase_id\": \"286\",\n    \"actually_paid\": \"100\"\n}\n\n

Response

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

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:
- 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.
\n

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.

\n","urlObject":{"protocol":"https","path":["api","payment"],"host":["gateway","faradpay","com"],"query":[],"variable":[]}},"response":[{"id":"3577ac49-70b6-4861-94f9-20461ccdf48f","name":"Recharge","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ABCD123456789000000XXXX","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"priceAmount\": 100.0,\r\n \"priceCurrency\": \"USDTBSC\",\r\n \"payCurrency\": \"USDTBSC\",\r\n \"network\": \"bsc\",\r\n \"orderId\": \"ORDER12345\",\r\n \"orderDescription\": \"Deposit (Online)\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://gateway.faradpay.com/api/payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.0 (Ubuntu)"},{"key":"Date","value":"Wed, 06 Aug 2025 09:59:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"713"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"2c9-QiCCZBdckRTlvglB0xyAtKpD89Y\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Payment created successfully\",\n \"data\": {\n \"paymentId\": \"pay_f3f0f904edd71314d6dc3f4f46c247b7\",\n \"paymentStatus\": \"waiting\",\n \"payAddress\": \"0x123456789xxxxxx\",\n \"payCurrency\": \"USDTBSC\",\n \"priceAmount\": \"100\",\n \"priceCurrency\": \"USDTBSC\",\n \"network\": \"bsc\",\n \"orderId\": \"ORDER12345\",\n \"orderDescription\": \"Deposit (Online)\",\n \"expiresAt\": \"2025-08-07T09:59:42.000Z\",\n \"createdAt\": \"2025-08-06T09:59:42.000Z\",\n \"updatedAt\": \"2025-08-06T09:59:42.000Z\",\n \"purchaseId\": \"286\"\n },\n \"_meta\": {\n \"statusCode\": 200,\n \"timestamp\": 1754474382729,\n \"requestId\": \"8ee55dd1-ee2c-4cf8-b399-fffabb56c9aa\",\n \"path\": \"/payment\",\n \"method\": \"POST\",\n \"duration\": 78,\n \"ip\": \"::1\",\n \"userAgent\": \"PostmanRuntime/7.44.1\",\n \"hostname\": \"faradpay.com\"\n }\n}"},{"id":"fa806d1e-9ca2-47c6-a1ed-b887543af0f1","name":"CallBackRechargeResponse","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ABCD123456789000000XXXX","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"payment_id\": \"pay_f3f0f904edd71314d6dc3f4f46c247b7\",\r\n \"payment_status\": \"finished\",\r\n \"pay_address\": \"0x123456789xxxxxx\",\r\n \"price_amount\": \"100\",\r\n \"price_currency\": \"USDTBSC\",\r\n \"pay_amount\": \"100\",\r\n \"pay_currency\": \"USDTBSC\",\r\n \"amount_received\": \"100\",\r\n \"order_id\": \"ORDER12345\",\r\n \"created_at\": \"2025-08-06 09:59:42\",\r\n \"updated_at\": \"2025-08-06 10:10:00\",\r\n \"purchase_id\": \"286\",\r\n \"actually_paid\": \"100\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://xyz.com/callBackResposne"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.0 (Ubuntu)"},{"key":"Date","value":"Wed, 06 Aug 2025 09:59:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"713"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"2c9-QiCCZBdckRTlvglB0xyAtKpD89Y\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Callback received\"\n}"}],"_postman_id":"07b01660-a0a5-4820-85ff-98092f7008b1"},{"name":"Withdrawal","id":"3bf42af3-905c-4acf-955b-59fc1a7a3b01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"name":"cache-control","sortOrder":2,"infoTitle":"We recommend using this header","info":"Postman added \"Cache-Control: no-cache\" as a precautionary measure to prevent the server from returning stale response when one makes repeated requests.\n\nYou can remove this header in the app settings or enter a new one with a different value.","allowedToToggle":false,"disableEdit":true,"previewSettingsLink":"Go to settings","key":"Cache-Control","value":"no-cache","system":true,"type":"text"},{"name":"postman-token","sortOrder":3,"infoTitle":"We recommend using this header","info":"The Postman-Token header appends a random UUID to every outgoing request. Postman adds this header for API developers to better debug requests sent and to ensure separate requests appear distinct to the receiving server.\n\nYou can remove this header in the app settings.","allowedToToggle":false,"disableEdit":true,"previewSettingsLink":"Go to settings","key":"Postman-Token","value":"","system":true,"type":"text"},{"name":"content-type","sortOrder":4,"infoTitle":"This header was automatically added","info":"The Content-Type header is added to help the server identify the media type of the request body that is present in this request.\n\nUse the request body tab to control the value or to remove this header.","allowedToToggle":true,"disableEdit":true,"previewSettingsLink":"Go to body","key":"Content-Type","value":"application/json","system":true,"type":"text"},{"name":"content-length","sortOrder":5,"infoTitle":"This header was automatically added","info":"The Content-Length header was added to indicate to the server the size of the request body that is added to this request. Server uses this value to parse the request body accurately.\n\nYou can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"previewSettingsLink":"Go to body","key":"Content-Length","value":"","system":true,"type":"text"},{"name":"host","sortOrder":6,"infoTitle":"We recommend using this header","info":"The Host header is added to identify the domain name for which a request is being sent to the server. This header is implicitly sent by every HTTP client.\n\nYou can remove the header or enter a new one with a different value. It is most likely that without this header, your request will return an HTTP 400 error.","allowedToToggle":true,"disableEdit":true,"key":"Host","value":"","system":true,"type":"text"},{"name":"user-agent","sortOrder":7,"infoTitle":"We recommend using this header","info":"The User-Agent header is added to help the server identify Postman as the HTTP requesting application or client.\n\nIt is recommended that this header be sent, but you can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"key":"User-Agent","value":"PostmanRuntime/7.39.1","system":true,"type":"text"},{"name":"accept","sortOrder":8,"infoTitle":"We recommend using this header","info":"The \"Accept: */*\" header is added to tell the server that Postman can understand and process all forms of response content types.\n\nIt is recommended that this header be sent, but you can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"key":"Accept","value":"*/*","system":true,"type":"text"},{"name":"accept-encoding","sortOrder":9,"infoTitle":"We recommend using this header","info":"The Accept-Encoding header is added to indicate to the server that Postman HTTP client supports a defined list of content-encoding or compression algorithms as response.\n\nYou can remove the header or enter a new one with a different value. Doing that may not accurately render the response within the app.","allowedToToggle":true,"disableEdit":true,"key":"Accept-Encoding","value":"gzip, deflate, br","system":true,"type":"text"},{"name":"connection","sortOrder":10,"infoTitle":"We recommend using this header","info":"Postman added the Connection header to indicate the server to keep the underlying network connection open once the current response is received. This allows Postman to reuse the same connection for faster response times in subsequent requests to the same server.\n\nYou can remove this header or enter a new one with a different value, such as `Connection: Close` to control this behaviour.","allowedToToggle":true,"disableEdit":true,"key":"Connection","value":"keep-alive","system":true,"type":"text"},{"key":"x-api-key","value":"ABCD123456789000000XXXX","type":"text","id":0},{"key":"Content-Type","value":"application/json","type":"text","id":1},{"key":"Accept","value":"application/json","type":"text","id":2}],"body":{"mode":"raw","raw":"{\r\n \"withdrawals\": [\r\n {\r\n \"address\": \"someaddress\",\r\n \"currency\": \"USDTBSC\",\r\n \"amount\": 1,\r\n \"ipnCallbackUrl\": \"https://faradpay.com/ap/ipn-handler\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://gateway.faradpay.com/api/payout","description":"

Payout API

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

Request Method

POST

Endpoint

https://gateway.faradpay.com/api/payout

Request Body

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

withdrawals (array): A list of withdrawal objects. Each object must include:
- address (string): The wallet address where the funds will be sent.
- currency (string): The type of cryptocurrency to be withdrawn (e.g., \"USDTBSC\").
- amount (number): The amount of cryptocurrency to withdraw.
- ipnCallbackUrl (string): A URL to which the payment notification will be sent.
\n

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.

\n","urlObject":{"protocol":"https","path":["api","payout"],"host":["gateway","faradpay","com"],"query":[],"variable":[]}},"response":[{"id":"5b97c793-660b-47ef-b7ec-10e4fac36d5f","name":"Withdrawal","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ABCD1234567890XXXXXXX","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"withdrawals\": [\r\n {\r\n \"address\": \"someaddress\",\r\n \"currency\": \"USDTBSC\",\r\n \"amount\": 1,\r\n \"ipnCallbackUrl\": \"https://xyz.com/ap/ipn-handler\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://gateway.faradpay.com/api/payout"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.0 (Ubuntu)"},{"key":"Date","value":"Wed, 06 Aug 2025 10:07:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"305"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"131-OW0dYSEG3XmRN7RbI+ZK/Xq9IsA\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Failed to initiate payout\",\n \"errors\": [],\n \"_meta\": {\n \"statusCode\": 400,\n \"timestamp\": 1754474833592,\n \"requestId\": \"13b3fd00-726a-41bc-95e7-6b8ef03da8cc\",\n \"path\": \"/payout\",\n \"method\": \"POST\",\n \"duration\": 13,\n \"ip\": \"::ffff:127.0.0.1\",\n \"userAgent\": \"PostmanRuntime/7.44.1\",\n \"hostname\": \"faradpay.com\"\n }\n}"}],"_postman_id":"3bf42af3-905c-4acf-955b-59fc1a7a3b01"}]}