Skip to main content
GET
/
api
/
v1.0
/
balance-inquiry
/
{account_id}
Get Account Balance
curl --request GET \
  --url https://sandbox-payment-b2b.singapay.id/api/v1.0/balance-inquiry/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-PARTNER-ID: <api-key>'
{
  "status": 200,
  "success": true,
  "data": {
    "held_balance": {
      "value": "1234.56",
      "currency": "IDR"
    },
    "available_balance": {
      "value": "1234.56",
      "currency": "IDR"
    },
    "pending_balance": {
      "value": "1234.56",
      "currency": "IDR"
    },
    "balance": {
      "value": "1234.56",
      "currency": "IDR"
    },
    "account_id": "01HZX9K3P2J4M6N8Q0R2T4V6W8"
  }
}

Authorizations

​
Authorization
string
header
required

JWT issued by POST /api/v1.1/access-token/b2b. Send Authorization: Bearer <token>.

​
X-PARTNER-ID
string
header
required

Merchant API key (Credential.api_key). Required on every request.

Path Parameters

​
account_id
string
required

ULID of the account whose balance is requested. The account must belong to the authenticated merchant.

Example:

"01HZX9K3P2J4M6N8Q0R2T4V6W8"

Response

Success

Successful response for account balance inquiry endpoint. Contains a data object with the balance snapshot for the specified account.

​
status
integer
required

HTTP status code.

Example:

200

​
success
boolean
required

Indicates whether the request was processed successfully. Always true for a 200 response.

Example:

true

​
data
object
required

Balance data for the specified account.