Skip to main content
POST
BRL Collection Application

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 July 16, 2026