Create payout

Special Notes — payout requests with an unknown outcome

When calling the payout API, network timeouts or unknown exceptions (with a response code of 5000) may occur. In such cases, the result of the transaction is unknown. Query the payout order status later to obtain the latest update.
If a network timeout occurs, you may retry after 2 minutes. First query using the same mch_order_no; retry only after confirming that no order was created, and keep the same order number.

The payout flowchart

Request URL

https://gateway.pay247.io/gateway/payout/create

Request Method

POST timestamp must be an integer; examples use milliseconds. Use v3.0 for version. Calculate sign as described in Signature. All merchant requests to the gateway must include uuid and include it in the signature. The response uuid comes from the request header or the server and need not match the request body.

Request fields

Field	Required	Type	Description
`mch_id`	Yes	string	Merchant ID
`mch_order_no`	Yes	string	Unique merchant order number
`currency`	Yes	string	Currency
`amount`	Yes	number	Amount, at most two decimal places; channel limits apply
`pay_method`	Yes	string	Method code; see catalog. Use `CRYPTO` for crypto orders; `TRC20` and `ERC20` are `network` values
`account_no`	Conditional	string	Required unless pay_method is CRYPTO
`account_name`	Conditional	string	Required for non-crypto INR payout
`bank_code`	Conditional	string	Valid 11-character IFSC required for non-crypto INR; otherwise channel-specific
`network`	Conditional	string	Required for CRYPTO; USDT: TRC20/ERC20/BEP20, USDC: ERC20/BEP20
`to_address`	Conditional	string	Required for CRYPTO; TRC20 T-prefixed 34-char address, EVM 0x plus 40 hex chars
`memo`	No	string	Crypto memo, max 128 characters
`bank_branch`	No	string	Bank branch
`notify_url`	No	URL	Callback URL
`mch_user_id`	No	string	Merchant user identifier, useful for order investigation
`channel_code`	No	string	Channel code; use only when arranged with the integration team
`timestamp`	Yes	integer	Timestamp
`version`	Yes	string	Use v3.0
`uuid`	Yes	string	Request ID; included in signature
`sign`	Yes	string	Signature

{
  "mch_id": "MCH12345678",
  "timestamp": 1693233334134,
  "version": "v3.0",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "sign": "<computed signature>",
  "mch_order_no": "PAYOUT-1001",
  "currency": "INR",
  "amount": "100.00",
  "pay_method": "BANK",
  "account_name": "Example Recipient",
  "account_no": "1234567890",
  "bank_code": "HDFC0001234",
  "notify_url": "https://merchant.example/notify/payout"
}

Successful response data

Field	Required	Type	Description
`mch_id`	Yes	string	Merchant ID that owns the order
`mch_order_no`	Yes	string	Order number supplied by the merchant
`order_no`	Yes	string	Platform order number generated by Pay247
`currency`	Yes	string	Currency
`amount`	Yes	string	Order amount in the order currency
`fee`	Yes	string	Order fee in the order currency
`status`	Yes	string	Usually PENDING or CONFIRMING; query for later status
`network`	CRYPTO only	string	Crypto network code; returned only for CRYPTO orders
`to_address`	CRYPTO only	string	Destination wallet address; returned only for CRYPTO orders and may be empty before assignment
`from_address`	CRYPTO only	string	Source wallet address; returned only for CRYPTO orders and may be empty
`transaction_hash`	CRYPTO only	string	On-chain transaction hash; returned only for CRYPTO orders and empty before available
`memo`	CRYPTO only	string	Crypto transfer memo; returned only for CRYPTO orders and empty if unused

{
  "code": 0,
  "message": "success",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": 1693233334135,
  "data": {
    "mch_id": "MCH12345678",
    "currency": "INR",
    "amount": "100.00",
    "fee": "2.00",
    "status": "PENDING",
    "order_no": "PO202609280001",
    "mch_order_no": "PAYOUT-1001"
  }
}

Crypto payout request

{
  "mch_id": "MCH12345678",
  "timestamp": 1693233334134,
  "version": "v3.0",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "sign": "<computed signature>",
  "mch_order_no": "PAYOUT-1002",
  "currency": "USDT",
  "amount": "50.00",
  "pay_method": "CRYPTO",
  "network": "TRC20",
  "to_address": "TFSPUcgpB4trALA6fqdK8AZ3KxoQjqjuB1",
  "notify_url": "https://merchant.example/notify/payout"
}

Payout fields by country

The country-specific guidance below is retained from the original documentation. Common fields are listed above; availability and bank fields still depend on merchant and channel configuration.

Indian (INR) Payout Request Parameters

Field	Required	Description
`mch_id`	Yes	Merchant ID
`mch_order_no`	Yes	Merchant order number
`currency`	Yes	INR
`amount`	Yes	Payout amount
`pay_method`	Yes	BANK is a bank-transfer example; check merchant configuration
`account_name`	Yes	Recipient name
`account_no`	Yes	Recipient account number
`bank_code`	Yes	11-character IFSC, e.g. HDFC0001234
`notify_url`	No	Callback URL
`timestamp`	Yes	Integer timestamp
`version`	Yes	Use v3.0
`uuid`	Yes	Request ID; included in signature
`sign`	Yes	Signature

Philippine (PHP) Payout Request Parameters

Field	Required	Description
`mch_id`	Yes	Merchant ID
`mch_order_no`	Yes	Merchant order number
`currency`	Yes	PHP
`amount`	Yes	Payout amount
`pay_method`	Yes	BANK is a bank-transfer example; check merchant configuration
`account_name`	By channel	Recipient name
`account_no`	Yes	Recipient account number
`bank_code`	By channel	Bank codes
`notify_url`	No	Callback URL
`timestamp`	Yes	Integer timestamp
`version`	Yes	Use v3.0
`uuid`	Yes	Request ID; included in signature
`sign`	Yes	Signature

Mexico (MXN) Payout Request Parameters

Field	Required	Description
`mch_id`	Yes	Merchant ID
`mch_order_no`	Yes	Merchant order number
`currency`	Yes	MXN
`amount`	Yes	Payout amount
`pay_method`	Yes	BANK is a bank-transfer example; check merchant configuration
`account_name`	By channel	Recipient name
`account_no`	Yes	Recipient account number
`bank_code`	By channel	Bank codes
`notify_url`	No	Callback URL
`timestamp`	Yes	Integer timestamp
`version`	Yes	Use v3.0
`uuid`	Yes	Request ID; included in signature
`sign`	Yes	Signature

For example USDT payout response (CRYPTO)

{
  "code": 0,
  "message": "success",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": 1693233334135,
  "data": {
    "mch_id": "MCH12345678",
    "currency": "USDT",
    "amount": "50.00",
    "fee": "2.00",
    "status": "PENDING",
    "order_no": "PO202609280002",
    "mch_order_no": "PAYOUT-1002",
    "network": "TRC20",
    "to_address": "TFSPUcgpB4trALA6fqdK8AZ3KxoQjqjuB1",
    "from_address": "",
    "transaction_hash": "",
    "memo": ""
  }
}

Original payout create example (response fields corrected)

{
  "code": 0,
  "message": "success",
  "uuid": "7eb3c9e-5a1d-4a19-be2a-c80eac39830a",
  "timestamp": 1594099906123,
  "data": {
    "mch_id": "X3DSKDKII2343",
    "mch_order_no": "R898543254325432",
    "order_no": "202007070427475133333",
    "currency": "USD",
    "amount": "99.11",
    "status": "PENDING",
    "fee": "3.60"
  }
}

Create responses do not contain the original example’s pay_method, paid_at, or error. Use Query payout for later status.

Quickstart

Balance

Payin

Payout

Reference

The payout flowchart

Request URL

Request Method

Request fields

Successful response data

Crypto payout request

Payout fields by country

Indian (INR) Payout Request Parameters

Philippine (PHP) Payout Request Parameters

Mexico (MXN) Payout Request Parameters

For example USDT payout response (CRYPTO)

Original payout create example (response fields corrected)

​The payout flowchart

​Request URL

​Request Method

​Request fields

​Successful response data

​Crypto payout request

​Payout fields by country

​Indian (INR) Payout Request Parameters

​Philippine (PHP) Payout Request Parameters

​Mexico (MXN) Payout Request Parameters

​For example USDT payout response (CRYPTO)

​Original payout create example (response fields corrected)

The payout flowchart

Request URL

Request Method

Request fields

Successful response data

Crypto payout request

Payout fields by country

Indian (INR) Payout Request Parameters

Philippine (PHP) Payout Request Parameters

Mexico (MXN) Payout Request Parameters

For example USDT payout response (CRYPTO)

Original payout create example (response fields corrected)