Inquiry saldo (Brasil)

API inquiry saldo wilayah Brasil (BRL).

Request

POST/v2.0/inquiry-balance

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/inquiry-balance
production: https://gateway.smilepayz.com/v2.0/inquiry-balance

Header Parameters

Field	Required	Type	Description
Content-Type	M	String	application/json request body.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Signature of JSON body (see product Signature doc).
X-PARTNER-ID	M	String	Your merchantID (alphanumeric).

Body Parameters

Field	Required	Type	Description
accountNo	M	String(128)	Settlement accountNo if gateway returns it.
balanceTypes	M	List(String)	e.g. ["BALANCE"]; types to return.

Catatan

Sandbox: accountNo adalah nilai uji yang dihasilkan.
Production: ambil dari backend merchant; lihat How to Get Production Account Number.

---

Example Body – Balance Inquiry Request:

Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:06:00-03:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

{
    "accountNo": "21320030202403071031",
    "balanceTypes": [
        "BALANCE"
    ]
}

Responses

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json request body.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

Field	Required	Type	Description
code	M	String	00 success, other values error.
message	M	String	UTF-8 human-readable result line.
accountInfos	M	Object	balanceType, amount, availableBalance.
balanceType	M	String	e.g. BALANCE.
amount	M	Object	BRL integer minor units (e.g. 5000 = BRL 50.00).
currency	M	String	Fixed to BRL.
value	M	String	Balance as string (minor units, e.g. "2500" = BRL 2500.00).
availableBalance	M	Object	Available balance; same shape as amount.
currency	M	String	Fixed to BRL.
value	M	String	Available as string.
accountNo	O	String	Settlement accountNo if gateway returns it.
name	O	String	Beneficiary full name (UTF-8).
balanceTypes	O	Array	Echo of requested types.

Example Body – Balance Inquiry Response:

Content-type: application/json 
X-TIMESTAMP: 2020-12-17T10:55:00-03:00

{
    "code": "00",
    "message": "Successful",
    "accountInfos": {
        "balanceType": "BALANCE",
        "amount": {
            "currency": "BRL",
            "value": "2500"
        },
        "availableBalance": {
            "currency": "BRL",
            "value": "2500"
        }
    },
    "accountNo": "21320030202403071031",
    "name": "Sandbox Test",
    "balanceTypes": [
        "BALANCE"
    ]
}