Skip to main content
POST
/
brl
/
collect
/
apply
BRL Collection Application
curl --request POST \
  --url https://uat-interface.haipay.asia/brl/collect/apply \
  --header 'Content-Type: application/json' \
  --data '
{
  "appId": 1054,
  "orderId": "M233323000059",
  "amount": "300",
  "phone": "09230219312",
  "email": "23423@qq.com",
  "name": "test",
  "inBankCode": "PIX",
  "payType": "QR",
  "partnerUserId": "149597870",
  "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}
'
{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M233323000059",
    "orderNo": "6023071013539074",
    "payUrl": "https://a.api-uat.php.com/1L9zQS2",
    "bankCode": "PIX",
    "bankNo": "PC0007I10000035",
    "qrCode": "00020101021228760011ph.ppmi.p2m0111OPDVPHM1XXX0315777148000000017041652948137245442930503001520460165303608540810000.php Of Mandalu62310010ph.allbank05062110000803***88310012ph.ppmi.qrph0111OPDVPHM1XXX63042763",
    "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
  }
}

​
Secret Key & Private Key (Generate Signature)

Body

application/json
​
appId
integer
required

Business ID (obtained from the backend, needs to be passed according to the currency in the URL)

​
orderId
string
required

Merchant order number

Maximum string length: 48
​
name
string
required

Payer's name (format: English letters, case-sensitive, and spaces allowed, 1-30 characters, "firstName middleName lastName" (middleName is optional), special characters !- are supported)

Required string length: 1 - 30
Pattern: ^[A-Za-z\s!-]+$
​
phone
string
required

Real phone number

​
email
string<email>
required

Real email address

​
amount
string
required

Transaction amount (unit: Brazilian Real, accurate to two decimal places; do not include punctuation such as commas) Range: 1-99999

Pattern: ^(?:[1-9]\d{0,4}|0)(?:\.\d{2})$
​
payType
string
required
​
inBankCode
string
required
​
callBackUrl
string<uri>
required

Redirect URL after successful user payment

​
callBackFailUrl
string<uri>
required

Redirect URL after failed user payment

​
partnerUserId
string
required

Unique user identifier (e.g., userID), used for risk control, must be valid; otherwise, it will affect the transaction. Format: digits, uppercase and lowercase letters, or common symbols such as -~!@#$%&*()_.

Pattern: ^[A-Za-z0-9\-~!@#$%&*()_]+$
​
sign
string
required

Signature

​
inBankNo
string

CPF (11 digits only)

Required string length: 11
Pattern: ^\d{11}$
​
notifyUrl
string<uri>

Callback URL

​
subject
string

Payment remark (transaction title, product name, payment reason)

​
body
string

Detailed remarks

Response

200 - application/json
​
status
string

1: Normal, 0: Exception

​
error
string

Error code

​
msg
string

Error description

​
data
object
Last modified on April 10, 2026