Create Collection

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

Endpoint

POST /cashin/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
bankCode	string enum	Yes	Collection method code — PIX
amount	number	Yes	Order amount — 20~49999; unit BRL; 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
name	string	Yes	Payer name — More realistic values improve payout success rate. Concatenate First Name and Last Name
phone	string	Yes	Customer phone — More realistic values improve success rate and reduce risk flags; Brazilian numbers start with +55
email	string	Yes	Customer email — More realistic values improve success rate and reduce risk-control flags
sign	string	Yes	Signature
appId	string	Yes	Merchant appId — appId assigned by the platform
mchOrderNo	string	Yes	Merchant order number
mchId	integer	Yes	Merchant ID
timestamp	integer	Yes	Current timestamp — Unix timestamp in seconds
txChannel	string	Yes	Transaction channel — Fixed value: TX_BAR_001
productInfo	string	Yes	Product information — Chinese characters are strictly prohibited
returnUrl	string	No	Checkout redirect URL
taxNumber	string	No	Tax number — Tax ID: CPF for individuals, CNPJ for companies. Must be real and valid
version	string	Yes	Version (fixed value) — API version, fixed value: 3.0

Request Example

{
 "mchId": 10404,
 "txChannel": "TX_BAR_001",
 "appId": "tt4KdQglLU5wiB7Fjg",
 "timestamp": 16624500121,
 "mchOrderNo": "order_20220918010",
 "bankCode": "PIX",
 "amount": "5",
 "version": "3.0",
 "name": "GSY",
 "phone": "18688984423",
 "email": "gssdyohqr@chvro.cy",
 "notifyUrl": "https://go-pay-test.targeted.work/callback/echo",
 "returnUrl": "http://test.sj/reutrun",
 "productInfo": "product info",
 "taxNumber": "47929001230",
 "sign": "xxxxxxxxx"
}

Response Parameters

Field	Type	Required	Description
status	integer	Yes	Status
msg	string	Yes	Message
data	object	Yes	Data
data.applyTime	integer	Yes	Application time — Timestamp format
data.amount	number	Yes	Actual paid amount
data.link	string	Yes	Payment link
data.expireTime	integer	Yes	Expiration time — Timestamp format
data.mchOrderNo	string	Yes	Merchant order number
data.platOrderNo	string	Yes	Platform order number
data.reference	string	Yes	Reference code — Merchants can generate a payment QR code from this value
data.helpMessage	string	Yes	Help message

Response Example

{
 "status": 200,
 "msg": null,
 "data": {
 "mchOrderNo": "order_1662112944",
 "platOrderNo": "P5nosqyWAQsQZNtYa5OW",
 "applyTime": 1662112986,
 "amount": 1200,
 "reference": "00020101021226840023br.gov.bcb.pix2563qr.iugu.com/public/payload/v2/68A08B21C34E43B398137645AC2BF5E7520400015313986540520.005802BR5912AAAAABB LTDA6009SAO PAULO62070503***63046D60",
 "link": "http://47.88.18.111:8032/?param=RjUzRUVBMTNBMTUwNUQwMURFMkQwNDc4RkI3OTM1Q0Q4OEJEQzhFN0VBMkNEMTQ0NzJEOTlBRjU2NDFFMDBGOQ==",
 "expireTime": 1662199387,
 "helpMessage": null
 }
}

Related

• Brazil
• Signature & Verification
• Collection Webhook