API REFERENCE

Brazil · Create collection

Endpoint, parameters and examples for Brazil: Create collection.

Endpoint#

POSThttps://YOUR_GATEWAY_HOST/Pay_Index.html

application/x-www-form-urlencoded

Parameters#

Field	Requirement	Signed	Description
`pay_memberid`	Required	Yes	Merchant number shown in the panel, not the internal user ID.
`pay_orderid`	Required	Yes	Original merchant collection order ID. Query this ID, not the platform ID returned on creation.
`pay_amount`	Required	Yes	BRL amount string with two decimal places. Limits and fees depend on merchant and product.
`pay_applydate`	Required	Yes	Request time, preferably yyyy-MM-dd HH:mm:ss in Brazil time. Do not assume a common signature validity window.
`pay_bankcode`	Required	Yes	Assigned payment product code enabled for this merchant.
`pay_notifyurl`	When applicable	When nonempty	Merchant notification URL; supply it to receive payment results.
`pay_callbackurl`	When applicable	When nonempty	Merchant browser return URL; may be omitted if no browser return is needed.
`pay_md5sign`	Required	No	32-character uppercase MD5 signature; exclude this field from signing.
`type`	Recommended	No	Use json for API order creation. JSON output depends on the assigned product; confirm its actual response format.
`pay_attach`	Optional	No	Additional data, returned as attach and excluded from collection signatures. Use type to request JSON output.
`pay_productname`	Optional	No	Product name; usage depends on the assigned product.

Field	Description
`status`	API processing result, not the final financial outcome.
`msg`	API message.
`pay_amount`	BRL amount; responses may use JSON numbers or strings without a fixed decimal format. Preserve the received value for verification.
`pay_orderid`	Platform order or transaction ID.
`payUrl`	Checkout URL, not proof of completed payment.
`qrCode`	Product-specific QR content: PIX text, Base64 or other data. Image URLs or uniform copy-and-paste PIX content are not guaranteed; confirm during integration.

Examples#

cURL · replace placeholders before use

curl --request POST 'https://YOUR_GATEWAY_HOST/Pay_Index.html' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'pay_memberid=10000' \
  --data-urlencode 'pay_orderid=DEMO_PAYIN_001' \
  --data-urlencode 'pay_amount=100.00' \
  --data-urlencode 'pay_applydate=2026-10-24 12:00:00' \
  --data-urlencode 'pay_bankcode=YOUR_PRODUCT_CODE' \
  --data-urlencode 'pay_notifyurl=https://example.com/payin/notify' \
  --data-urlencode 'pay_callbackurl=https://example.com/payin/return' \
  --data-urlencode 'type=json' \
  --data-urlencode 'pay_md5sign=CALCULATE_WITH_YOUR_APIKEY'

Request fields · submit as form

{
  "pay_memberid": "10000",
  "pay_orderid": "DEMO_PAYIN_001",
  "pay_amount": "100.00",
  "pay_applydate": "2026-10-24 12:00:00",
  "pay_bankcode": "YOUR_PRODUCT_CODE",
  "pay_notifyurl": "https://example.com/payin/notify",
  "pay_callbackurl": "https://example.com/payin/return",
  "type": "json",
  "pay_md5sign": "CALCULATE_WITH_YOUR_APIKEY"
}

Response example

{
  "status": "1",
  "msg": "下单成功",
  "pay_amount": 100.0,
  "pay_orderid": "DEMO_PLATFORM_PAYIN",
  "payUrl": "https://example.com/cashier/DEMO",
  "qrCode": "PRODUCT_SPECIFIC_QR_CONTENT"
}

Response example

{
  "status": "error",
  "msg": "签名验证失败",
  "data": []
}

Signing & result handling#

Compute the signature over the operation-specific field set, not every example field.

Open signing guide