Create Payout

WARNING

Note: if the response times out or returns a non-200 HTTP status code, confirm the order status with operations before resubmitting

WARNING

Important: name + phone + email + amount are used to identify distinct customers. Follow these notes to avoid incorrect risk-control decisions.

1. Do not hard-code name, phone, and email together
2. Use the same name + phone + email for the same customer

Brazil transfer account formats (account) PIX_CPF 11 digits PIX_CNPJ 14 digits PIX_EMAIL email format PIX_PHONE +55{11 digits} PIX_EVP ^[0-9 a-z]{8}-[0-9 a-z]{4}-[0-9 a-z]{4}-[0-9 a-z]{4}-[0-9 a-z]{12}$

Endpoint

POST /cashout/bra/order/create

Request Headers

Name	Required	Example	Description
Content-Type	Yes	application/json
lang	No	en	Response language: zh Chinese, en English, pt Portuguese

Request Parameters

Field	Type	Required	Description
name	string	Yes	Payer name — More realistic values improve checkout success rate. Concatenate First Name and Last Name
phone	string	Yes	Customer mobile number — More realistic values improve success rate and reduce risk flags; numbers start with +55
email	string	Yes	Customer email — More realistic values improve success rate and reduce risk-control flags
bankCode	string enum	Yes	Payout code — PIX_CPF, PIX_CNPJ, PIX_PHONE, PIX_EMAIL, PIX_EVP
account	string	Yes	Account number — Account depends on bankCode: for PIX_CPF use CPF number; for PIX_PHONE use phone with country code in +55... format;
amount	number	Yes	Amount — 10~49999; up to 2 decimal places (rounded). Trailing zeros after the decimal are omitted in the pre-sign string for float amounts
notifyUrl	string	Yes	Notification callback URL — Sandbox supports automatic callbacks: odd last digit of phone → success; even → failure
sign	string	Yes	Signature
appId	string	Yes	Merchant appId
mchOrderNo	string	Yes	Merchant order number
mchId	integer	Yes	Merchant ID
txChannel	string	Yes	Transaction channel — Fixed value: TX_BAR_001
timestamp	integer	Yes	Current timestamp — Unix timestamp in seconds
taxNumber	string	Yes	Tax ID: CPF for individuals, CNPJ for companies — must be real and valid
productInfo	string	No	Transfer remark — Chinese characters are strictly prohibited; default: Withdrawal

Request Example

{
 "mchId": 10404,
 "txChannel": "TX_BAR_001",
 "appId": "QByyZWJCFhiNupV1xl",
 "timestamp": 16624500121,
 "mchOrderNo": "payout_16622125006",
 "name": "Matthew Clark",
 "phone": "19818970682",
 "email": "test@gmail.com",
 "bankCode": "PIX_EMAIL",
 "account": "test@gmail.com",
 "amount": "180.50",
 "notifyUrl": "http://xmevj.kg/obp",
 "sign": "xxxxxxxxx",
 "taxNumber": "45920019932",
 "productInfo": "Withdrawal123"
}

Response Parameters

Field	Type	Required	Description
status	integer	Yes	Status — 200 success
msg	string	Yes	Message
data	object	Yes
data.applyTime	integer	Yes	Application time
data.amount	number	Yes	Credited amount
data.platOrderNo	string	Yes	Platform order number
data.mchOrderNo	string	Yes	Merchant order number
data.orderStatus	string	Yes	Order status

Response Example

{
 "status": 200,
 "msg": null,
 "data": {
 "mchOrderNo": "payout_1662104438",
 "platOrderNo": "wussXUCOoXO3yptr7rQV",
 "applyTime": 1662104742,
 "amount": 180.34,
 "orderStatus": "PENDING"
 }
}

Related

• Brazil
• Signature & Verification
• Payout Webhook