Brick API Documentation
Brick

Get Balance

This SNAP Disbursement guide is currently available in English.

Retrieve your current Brick balance through the SNAP Disbursement contract.

GET /v2/payments/disbursements/snap/balance

This endpoint is read-only and does not accept a request body.

Request headers

HeaderRequiredDescription
AuthorizationYesBearer followed by your SNAP access token.
X-CLIENT-KEYYesClient ID from Configuration → API Credentials.
X-TIMESTAMPYesRFC3339 / ISO 8601 timestamp with a timezone, within plus or minus 10 minutes of server time.
X-SIGNATUREYesRequest signature for the Get Balance request. See Setup Client Key and Signature.
X-REFERENCE-IDYesA new UUID identifying this request.

Retrieve balance

Request · cURL

TerminalCode
curl --request GET \ --url '{{base_url}}/v2/payments/disbursements/snap/balance' \ --header 'Authorization: Bearer snap_demo_20261020_83ac67125b8f' \ --header 'X-CLIENT-KEY: 83ac6712-5b8f-4b0d-9e24-63aa79102d45' \ --header 'X-TIMESTAMP: 2026-10-20T09:00:00+07:00' \ --header 'X-SIGNATURE: U05BUC1ET0NTLUVYQU1QTEUtU0lHTkFUVVJFLU5PVC1GT1ItQVVUSA==' \ --header 'X-REFERENCE-ID: 61fd8e9b-4c37-4d5a-83bd-2b4589c0a621'

Response · HTTP 200

JSONCode
{ "responseCode": "2001100", "responseMessage": "Successful", "accountInfos": [ { "balanceType": "Cash", "amount": { "value": "10100380255.00", "currency": "IDR" }, "floatAmount": { "value": "1000000.00", "currency": "IDR" }, "availableBalance": { "value": "10099380255.00", "currency": "IDR" } } ], "additionalInfo": { "source": "API", "entity": "Payment", "sameDaySettlement": { "isActive": true, "earlySettlementBalanceQuota": { "value": "500000.00", "currency": "IDR" } } } }

Response fields

FieldTypeDescription
responseCodestring2001100 for a successful balance retrieval.
responseMessagestringAPI response description.
accountInfosarrayBalance information for the account.
accountInfos[].balanceTypestringBalance type, for example Cash.
accountInfos[].amountobjectTotal Balance.
accountInfos[].floatAmountobjectPending Balance.
accountInfos[].availableBalanceobjectUsable Balance.
*.valuestringAmount with exactly two decimal places.
*.currencystringCurrency code: IDR.
additionalInfo.sourcestringBalance data source.
additionalInfo.entitystringEntity associated with the balance.
additionalInfo.sameDaySettlement.isActivebooleanWhether Same Day Settlement is active.
additionalInfo.sameDaySettlement.earlySettlementBalanceQuotaobjectEarly Settlement Balance Quota.

Error responses

ConditionHTTP statusresponseCoderesponseMessage
Invalid access token4014010103Token Not Found (B2B)
Invalid request signature4014010100Unauthorized. X-SIGNATURE does not match the registered public key and request payload
Malformed or out-of-window timestamp4014011100Unauthorized. X-TIMESTAMP must be RFC3339 and within ten minutes of server time

For request recovery guidance, see Error Handling.

Last modified on