Create Withdraw Order (Brazil)

創建巴西雷亞爾（BRL）withdrawal order.

Request Information

• Request URL: /gateway/api/v2/payouts
• Request Method: POST
• Content-Type: application/json;charset=utf-8

Request Parameters

Parameter	Required	Type	Description
platform_id	Yes	String(7)	Merchant ID
service_id	Yes	String(7)	Service ID，Fixed value SVC0023
payout_cl_id	Yes	String(32)	Merchant Order ID
amount	Yes	Integer(10)	Amount (in cents)
notify_url	No	String(256)	Transaction Result Notification URL
number	Yes	String(64)	受款人 PIX 鑑別碼，接受五種格式：用戶的郵箱/帶國際區號手機號(例如+55XXXXXXX)/CPF/CNPJ/EVP
currency	Yes	String(3)	Fixed value: brl
request_time	Yes	Integer(10)	Request Time (Unix timestamp in seconds)
sign	Yes	String(32)	Order Signature

Request Example

{
  "amount": 50000,
  "notify_url": "https://xxx.xx/notification",
  "number": "49251626839",
  "payout_cl_id": "DEVPOT00143538",
  "platform_id": "PF0002",
  "request_time": "1595504997",
  "service_id": "SVC0023",
  "sign": "8ac38fb87c2bcce4cf36627d4f8aa747"
}

Response Example

Success Response

{
  "error_code": "0000",
  "data": {
    "payout_id": "POT00000001"
  }
}

Error Response Example

{
  "error_code": "0004",
  "error_msg": "Signature verification failed!"
}

Response Parameter Description

Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Error message (returned when error_code is not "0000")
payout_id	String	Platform Order ID

Remarks

Important Notice

Due to network fluctuations, high concurrency, attacks and other force majeure factors, if you encounter timeout, HTTP 500 error, empty response, or network delay when calling the withdrawal API, please use the Order Query API status as reference, or contact operations personnel with the merchant order number for manual verification. The platform is not responsible for any losses caused by rejecting withdrawal orders without manual confirmation from operations personnel!

• Merchant ID is a unique identifier assigned by the system. If not obtained, please contact system personnel
• Service ID please enter SVC0004
• 交易Amount單位為巴西雷亞爾 BRL（分），Please multiply by 100，For example, to collect 10000.00, pass value 1000000
• Request time uses Unix timestamp in seconds
• Returning "0000" only indicates the API call was successful, not the transaction status. Please call the Query API to confirm the result
• If server response is not received (e.g. 5xx HTTP status), you must call the Query API or wait for callback. Do not treat the order as failed directly