Payout Orders

Payout Request

URL

POST /accountProxyPay/initPay

Request Parameters

Field Name	Description	Type	Max Length	Required	Remarks	Example
userOrderNumber	User Order Number	string	50	Yes	Custom user-defined order number
submitAmount	Order Amount	string	12	Yes	Amount unit: BRL	200
accountType	Payout Account Type	string	12	Yes	Supported values: CPF, CNPJ, PHONE, EMAIL, EVP
bankCard	Recipient Account	string	40	Yes	PIX payout account. Regardless of type, pass this value including: phone, email, tax ID, random key (EVP). When passing phone number, add +55 country code
currencyType	Currency Type	string	40	Yes	Fixed value:BRL
notifyUrl	Callback URL	string	255	No	Payout callback URL. Notification sent every minute upon success or failure. If response returns success, notifications will stop

Response Parameters

Field Name	Description	Type	Max Length	Required	Remarks	Example
orderNo	System Order Number	string	50	Yes	Platform-generated order number
orderState	Order Status	int	4	Yes	10-Processing 20-Success 30-Failed
serialNo	User Order Number	string	50	Yes	User-defined order number
message	Failure Reason	string	200	No	Returned only when payout fails

Payout Query

URL

POST/proxyPayQuery/query

Request Parameters

Field Name	Description	Type	Max Length	Required	Remarks	Example
userOrderNumber	User Order Number	string	50	Yes	Used to query payout order

Response Parameters

Field Name	Description	Type	Max Length	Required	Remarks	Example
serialNo	User Order Number	string	50	Yes	User-defined order number
orderNo	System Order Number	string	50	Yes	Platform order number
orderState	Order Status	int	4	Yes	10-Processing 20-Success 30-Failed
amount	Order Amount	string	12	Yes	Payout amount	200
message	Failure Reason	string	200	No	Returned only when payout fails

Callback(Webhook)

Request Parameters

Field Name	Description	Type	Max Length	Required	Remarks	Example
serialNo	User Order Number	string	50	Yes
orderNo	System Order Number	string	50	Yes
arrivalAmount	Actual Paid Amount	string	12	No	Not returned if payout fails
Unit: BRL	200
orderState	Order Status	int	4	Yes	10-Processing 20-Success 30-Failed
message	Failure Reason	string	200	No	Returned only when payout fails

Callback Parameters

success

Recommendations to Improve Payout Success Rate

CPF:
⚫ Must be exactly 11 digits, numbers only
⚫ No letters allowed
⚫ No special characters allowed
⚫ Correct: 49860282862
⚫ Incorrect: 498.602.828-62
CNPJ:
⚫ Must be exactly 14 digits, numbers only
⚫ No letters allowed
⚫ No special characters allowed
⚫ Correct: 20626643000152
⚫ Incorrect: 20.626.643/0001-52
PHONE:
⚫ Brazilian phone numbers are 11 digits. With international prefix "+55", total length becomes 14 characters. It's recommended that customers don't input the international code manually.
⚫ Input field can be limited to 11 digits, error if exceeds or doesn't meet field requirements.
⚫ No letters allowed.
⚫ No special characters allowed.
⚫ The first digit must not be "0", otherwise error, as Brazilian phones don't start with "0". Our final submission to the bank is '+55xxxxxxxxxxx', After the user inputs 11 digits, the merchant system must automatically prepend +55 before submission.
⚫ To avoid confusion between CPF and PHONE input:
Display a +55 prefix indicator before the input field;
Clearly prompt users that this field is for phone number input.
EMAIL:
⚫ Only check whether the value contains @. If @ is present, submission is allowed