1、Create Pay in

Enables merchants to initiate payment requests, which return a payment link or QR code for end-users to complete the payment.

Request Method

• POST

URL：

/api/v3/bra/createCollectingOrder

• Content-Type：

Content-Type: application/json; charset=utf-8

Header Parameters（Header）

Param	Type	Description	Sample
access_key	String	Access key obtained from the merchant backend	pFqV75X3
timestamp	int64	Unix timestamp in milliseconds (13-digit)	1679724896223
nonce	String	UUID v4 random string	794c26b0-d33c-4394-b2bb-c485eca16d9e
sign	String	Signature calculated through signature algorithm	kAXyh+eerqrefyaF8dyFB0M4FVo=

All the above parameters are passed as HTTP headers

Example of requesting body data

{
  "amount": "21.1",
  "channelType": "PIX",
  "externalOrderId": "389508808434869257",
  "notifyUrl": "http://192.168.135:30002/abc",
  "remark": "123",
  "returnUrl": "http://192.168.135:30002/abc"
}

Parameter description:

Param	Desc	Require	Sample
amount	String	required	The receiving amount cannot exceed 2 decimal places. Unit: BRL (Brazilian Real)
channelType	String	required	Channel type, enumeration value: PIX
externalOrderId	String(64)	required	Unique order number in the merchant system
userInfoType	String(64)	optional	User information types (such as CPF, Phone, etc.)
userInfoNo	String(64)	optional	User information number (such as CPF number)
userInfoName	String(255)	optional	User Name
notifyUrl	String	required	Callback address after payment completion (server)
remark	String	optional	Merchant customized note information
returnUrl	String	optional	After successful payment, the user will be redirected to the front-end address

response type：

Header: { 'Content-Type': 'application/json;charset=utf-8'}

Create payment response instructions:

Example of Normal Response Data (HTTP 200）

{
  "code": "200",
  "success": true,
  "msg": "成功",
  "msgEn": "SUCCESS",
  "data": {
    "cashierCurrencyAmount": "21.1",
    "cashierExpireTime": 1690431343212,
    "cashierId": "OCURRPAID202307270345411690429541853DOCKER020000000200000775",
    "cashierUrl": "http://192.168.1.74:88/OCURRPAID202307270345411690429541853DOCKER020000000200000775?...",
    "currency": "BRL",
    "currencyOrderVo": {
      "amount": "21.1",
      "currency": "BRL",
      "externalOrderId": "828905760411449635",
      "orderId": "OCURRPAID202307270345431690429543531DOCKER020000000400000776",
      "orderStatus": "Wait pay",
      "orderStatusCode": 1,
      "orderTime": 1690429543571,
      "payParam": "...",
      "payType": 101,
      "tradeNote": "123"
    },
    "isCreateOrder": true,
    "isHiddenMerchantLogo":null,
    "isHiddenMerchantName":null,
    "payType": 101,
    "returnUrl": "http://192.168.135:30002/abc",
    "userInfoName": "Alisha Lovetinsky",
    "userInfoNo": "00828761000",
    "userInfoType": "CPF",
    "version":null,
    "payTypeCode": "PIX"
  }
}

Response parameter description

Param	Type	Desc
cashierCurrencyAmount	String	Collection amount (for display purposes, consistent with the order amount)
cashierExpireTime	int64	Cashier expiration time (timestamp)
cashierId	String	Cashier Order ID
cashierUrl	String	Jump to the checkout payment link
currency	String	Currency code (e.g BRL）
amount	String	The original amount of the order, the amount initiated when the order was created
externalOrderId	String	Merchant order number
orderId	String	System Order ID
orderStatus	String	Order status description (such as: Wait pay）
orderStatusCode	int64	Order status code: 1=Pending payment; 2=Payment successful (final status)
orderTime	int64	Order creation time (timestamp)
payParam	String	Payment parameters (payment codes that comply with the Brazilian PIX standard and can be directly used to generate QR codes), which can be used to create self built payment pages
tradeNote	String	Transaction remarks information
isCreateOrder	bool	Whether the order has been successfully created, true/false
payType	int64	Payment type code (e.g. 101=PIX)
returnUrl	String	After payment is completed, redirect to the front-end address
userInfoName	String	User Name
userInfoNo	String	User information number (such as CPF number)
userInfoType	String	User information types (such as CPF, Phone, etc.)
payTypeCode	String	Payment channel identification (such as: PIX, TED）
isHiddenMerchantLogo	bool	Do you want to hide the merchant logo
isHiddenMerchantName	bool	Do you want to hide the merchant name
version	String	version