Skip to main content
POST
BRL Disbursement Application
All example requests on this page are based on the sandbox (test) environment. Please be careful to distinguish it from the production environment.

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
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}|99999)(?:\.\d{2})?$
accountType
string
required

Account type: EWALLET (electronic wallet)

bankCode
string
required

Wallet code

identifyType
string
required

Account type (CPF/PHONE/EMAIL)

accountNo
string
required

User's receiving account numbe

name
string
required

Recipient's name (Format: uppercase English letters, may include spaces, 1-30 characters, "firstName middleName lastName" (middleName is optional, special characters like '.- are supported))

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

Real phone number (refer to the phone format)

email
string<email>
required

Real email address

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

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 October 13, 2026