Balance Inquiry

Method and URL

POST [BASE_URL]/wallet-backend/snap/v1.0/balance-inquiry

Purpose: View a user’s current wallet balance.

Authorization:

  • B2B Token

  • B2B2C Token

Request

Request Header

Header
Requirement
Description

Content-Type

Mandatory

application/json

Authorization

Mandatory

Bearer {B2B_access_token}

Authorization-Customer

Mandatory

Bearer {B2B2C_access_token}

X-SIGNATURE

Mandatory

HMAC signature generated as per SNAP specification

HMAC_SHA512 (clientSecret, stringToSign)

stringToSign = HTTPMethod +”:“+ EndpointUrl +":"+ AccessToken +":“+ Lowercase(HexEncode(SHA-256(minify(RequestBody))))+ ":“ + TimeStamp

X-TIMESTAMP

Mandatory

Request timestamp in yyyy-MM-dd'T'HH:mm:ssXXX (ISO 8601 with offset)

X-PARTNER-ID

Mandatory

Partner ID assigned by Pivot

X-EXTERNAL-ID

Mandatory

Unique ID per request for idempotency / tracing

CHANNEL-ID

Mandatory

Channel identifier (e.g., 12345)

Request Body

{
  "additionalInfo": {}
}

Request Parameter Detail

Parameter
Data Type
Character Limit
Requirement
Description

additionalInfo

Object

-

Optional

Container for additional information.

Response

Response Body

{
  "accountInfos": [
    {
      "availableBalance": {
        "currency": "IDR",
        "value": "8463186.00"
      },
      "balanceType": "CASH"
    }
  ],
  "responseCode": "2001100",
  "responseMessage": "Successful"
}

Response Parameter Detail

Parameter
Data Type
Character Limit
Requirement
Description

accountInfos

Array

-

Mandatory

List of balance information objects for the user’s account.

accountInfos[].availableBalance

Object

-

Mandatory

Object containing the available balance details.

accountInfos[].availableBalance.currency

String

3

Mandatory

Currency code of the balance, e.g., IDR.

accountInfos[].availableBalance.value

String

20

Mandatory

Available balance amount in decimal string format (e.g., "8463186.00").

accountInfos[].balanceType

String

20

Mandatory

Type of balance, e.g., CASH.

responseCode

String

7

Mandatory

Response status code. "2001100" indicates successful balance inquiry.

responseMessage

String

100

Mandatory

Description of the result, e.g., "Successful".

Last updated