Collection Orders

Collection Request

URL

POST /accountProxyCollect/initCollect

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
paymentType	Collection Type	string	20	Yes	Fixed value：PIX
currencyType	Currency Type	string	40	Yes	Fixed value:BRL
notifyUrl	Callback URL	string	255	No	Collection 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
url	Payment Link	string	200	Yes	Payment link
qrCode	QR Code String	string	200	Yes	QR code content
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 collection fails

Collection Inquiry

URL

POST /proxyCollectQuery/query

Request Parameters

Field Name	Description	Type	Max Length	Required	Remarks	Example
userOrderNumber	User Order Number	string	50	Yes	Used to query collection 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
arrivalAmount	Actual Collected Amount	string	12	Yes	Unit：BRL	200
amount	Submitted Amount	string	12	Yes	Unit：BRL	200
transTime	Order Completion Time	Date	100	Yes	Order completion timestamp
message	Failure Reason	string	200	No	Returned only when collection 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
amount	Order Amount	string	12	Yes	Unit: BRL	200
arrivalAmount	Actual Collected Amount	string	12	Yes	Unit: BRL	200
orderState	Order Status	int	4	Yes	10-Processing 20-Success 30-Failed
message	Failure Reason	string	200	No	Returned only when collection fails

Callback Parameters

success

When invoking the collection or payout application APIs, if the callback URL field notifyUrl is provided, the platform will notify the callback URL once every minute when the collection or payout order is successful or failed. If the callback response returns success, the notification will stop. In special cases such as network fluctuations, duplicate notifications may occur. Please ensure idempotent handling is implemented.