2、Create payment out

Proxy payment order PIX

Used for merchants to initiate PIX payment requests, the system will execute the transfer to the recipient's account.

Request method

• POST

Request URL

Either of the following two URLs can be used (with consistent functionality)：

/api/v3/bra/createTransferOrder
/api/v3/bra/pix/createTransferOrder

• 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 parameters need to be sent in the header. Please refer to the data signature specification for signature generation

Example of requesting body data

{
  "currencyAmount": "20.01",
  "channelType": "PIX",
  "externalOrderId": "871049832638078444",
  "personIdType": "CPF",
  "personId": "18171847084",
  "personName": "bob",
  "accountType": "CPF",
  "accountId": "18171847684",
  "remark": "123",
  "notifyUrl": "http://192.168.1.135:30002/abc"
}

Parameter description:

**Suggestion **: To improve the efficiency of proxy payment processing, it is recommended to pass in all of the following fields.

Param	Desc	Require	Sample
currencyAmount	String	required	Payment amount, retain up to 2 decimal places
channelType	String	required	Payment type, enumeration value: PIX
externalOrderId	String(64)	required	Merchant order number
personIdType	String(64)	required	User's ID type: CPF, CNPJ (choose one)
personId	String(64)	required	User's ID number
personName	String(255)	required	User's name
accountType	String	required	Recipient account type, enumeration values: CPF, CNPJ, PHONE, EMAIL, EVP (choose one)
accountId	String	required	Recipient account, must match accountType
remark	String(255)	optional	Transaction remark
notifyUrl	String	optional	Asynchronous notification callback URL (suggested to be a public address)

Response Example

Response Header Type

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

Response Data (Success)

{
  "code": "200",
  "success": true,
  "msg": "成功",
  "msgEn": "SUCCESS",
  "data": {
    "currencyType": "BRL",
    "externalOrderId": "472512322065926592",
    "orderId": "OCURRDAW20230727035446169042954635BDOCKER020000002000000777",
    "orderStatus": "Accepted"
  }
}

Response Field Description

Param	Type	Desc
currencyType	String	Currency type
externalOrderId	String	Merchant order ID
orderId	String	System order ID
orderStatus	String	Order status, normally returns "Accepted", status is updated later through query/callback