> ## Documentation Index > Fetch the complete documentation index at: https://docs.singapay.id/llms.txt > Use this file to discover all available pages before exploring further. # Get Merchant Balance > Retrieve the aggregated balance snapshot (held, available, pending and total) for the authenticated merchant. ## OpenAPI ````yaml https://payment-b2b.singapay.id/api/docs/merchant-api.json get /api/v1.0/balance-inquiry openapi: 3.1.0 info: title: Singa Merchant API description: >- OpenAPI specification for the merchant/partner HTTP API. All routes below are additionally protected by `ip.whitelisted.merchant` — the caller IP must be registered for the credential or merchant. Obtain a JWT using `POST /api/v1.0/access-token/b2b` (Basic auth) or `POST /api/v1.1/access-token/b2b` (X-Signature) before calling secured endpoints. version: 1.0.0 servers: - url: https://sandbox-payment-b2b.singapay.id description: >- API host. Paths include `/api` prefix (see `RouteServiceProvider`). Replace scheme/host with your environment. security: [] tags: - name: Security description: >- Merchant authentication (`OauthMerchantTokenController`). **v1.1** B2B token uses `X-CLIENT-ID`, `X-PARTNER-ID`, and `X-Signature` (no Basic auth). Secured routes also require the issued Bearer JWT plus `X-PARTNER-ID`. - name: Accounts description: >- Account management (`routes/merchantApiRoute.php`, `v1.0`). Path parameter `{id}` is always the account ULID. - name: Balance Inquiry description: >- Merchant and per-account balance inquiry (`BalanceController`, `v1.0`). Path `account_id` is the account ULID. - name: Statements description: >- Per-account statement list and detail (`AccountController::accountStatements`, `accountStatementDetail`, prefix `v1.0/statements`). Flugger responses; detail path param `{statement_id}` maps to `statements.transaction_id`. - name: Payment Link description: >- Payment link CRUD and payment-method catalog (`PaymentLinkApiController`, prefix `v1.0/payment-link-manage`). `account_id` is ULID; `payment_link_id` is numeric `payment_links.id`. - name: Payment Link History description: >- Payment link transaction/history listing and detail (`PaymentLinkApiController`, prefix `v1.0/payment-link-histories`). `history_id` is numeric `payment_link_histories.id`. - name: Virtual Account description: >- Native VA CRUD (`VirtualAccountController`, prefix `v1.0/virtual-accounts`). `account_id` and `virtual_account_id` are ULIDs. - name: VA Transaction description: >- VA money-in transaction listing and detail (`VirtualAccountController`, prefix `v1.0/va-transactions`). - name: QRIS (Money In) description: >- MPM dynamic QRIS list, show, and generate (`QrisMpmDynamicApiController`, prefix `v1.0/qris-dynamic`). - name: QRIS (Money Out) description: >- Issuer MPM decode/inquiry, payment credit (money out), and transaction status (`QrisIssuerMpmController`, `QrisApiV2Controller::checkStatus`, prefix `v2.0/qris`). Related list/detail: `GET /api/v2.0/qris/transaction/...`. - name: E-Wallet (Money In) description: >- E-Wallet Native checkout and transactions (`EwalletNativeApiController`, `EwalletNativeTransactionApiController`, `EwalletNativeV2ApiController`). Paths include `v1.0/ewallet-native`, `v1.0/ewallet-native-transactions`, and `v2.0/ewallet-native`. - name: E-Wallet (Money Out) description: >- E-wallet disbursement / top-up to beneficiary wallets (`EWalletTopUpController`, prefix `v2.0/ewallet`). Responses use the custom **`MerchantV2ApiEnvelope`** with **`MerchantV2ResponseCode`** (SP000–SP020). - name: Card (Money In) description: >- One-time card payment, cancel, and inquiry (`CardPaymentMerchantApiController`, prefix `v2.0/card`). - name: Subscription (Recurring) description: >- Credit-card recurring subscription plans (`SubscriptionPlanApiController`, prefix `v2.0/recurring`). Plan `{id}` is UUID (`sub_plans.id`). - name: Direct Debit description: >- Direct Debit — bind a customer bank account once via hosted webview, then charge it host-to-host (`DirectDebitMerchantController`, prefix `v2.0/direct-debit`). Binding `{binding_id}` and transaction `{transaction_id}` are UUIDs. Responses use the **`MerchantV2ApiEnvelope`** with both standard SP000–SP020 codes and Direct-Debit-specific codes (`SP_DD_*`). The `/charge` endpoint is additionally protected by **`X-Signature`** + **`X-Timestamp`** (`verify.signature-internal`); see operation parameters for the signing scheme. - name: Account Transfer description: >- Move funds between sub-accounts within the same merchant (`AnotherAccountApiController`, prefix `v1.0/account-transfer`). The transfer endpoint requires request signature headers (`verify.signature-internal`). Both accounts must belong to the authenticated merchant and be accessible to the credential. - name: Disbursement (Money Out) description: >- Bank disbursement (`DisbursementController` **v1.0**, `DisbursementV2Controller` **v2.0**). **v1.0** list/show/fee/beneficiary/transfer use Flugg envelopes; v1 inquiry-status uses the **custom v2 envelope** (`MerchantV2ApiEnvelope`, codes **SP000–SP020**). **v2.0** check-beneficiary, transfer, and inquiry-status use the same custom envelope — see component schema **`MerchantV2ResponseCode`** for the full response code table. - name: Cardless Withdrawal description: >- Cardless withdrawal API for initiating ATM cash withdrawals without a physical card. Supports creating withdrawals with OTP generation, listing transaction history, viewing transaction details, canceling pending withdrawals, and deleting canceled records. All endpoints use the `v1.0/cardless-withdrawals` route prefix and the standard success/error response envelope. Path parameter `{id}` refers to the `transaction_id` (platform-assigned business identifier). paths: /api/v1.0/balance-inquiry: get: tags: - Balance Inquiry summary: Get Merchant Balance description: >- Retrieve the aggregated balance snapshot (held, available, pending and total) for the authenticated merchant. operationId: balanceInquiryMerchant responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BalanceInquiryMerchantSuccessResponse200' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/BalanceInquiryErrorResponse401' '404': description: >- Not found — the specified merchant does not exist or is not accessible. content: application/json: schema: $ref: '#/components/schemas/BalanceInquiryErrorResponse404' '405': description: >- Method not allowed — the specified merchant exists but the authenticated user is not authorized to access it. content: application/json: schema: $ref: '#/components/schemas/BalanceInquiryErrorResponse405' security: - BearerAuth: [] PartnerId: [] components: schemas: BalanceInquiryMerchantSuccessResponse200: description: >- Successful response for merchant balance inquiry endpoint. Contains a data object with the balance snapshot. required: - status - success - data properties: status: description: HTTP status code. type: integer example: 200 success: description: >- Indicates whether the request was processed successfully. Always `true` for a 200 response. type: boolean example: true data: $ref: '#/components/schemas/InquiryBalanceMerchantData' description: Balance data for the merchant. type: object BalanceInquiryErrorResponse401: description: >- Error response envelope for 401 Unauthorized responses from balance inquiry endpoints. Contains an error message and optional details. properties: status: description: HTTP status code. type: integer example: 401 success: description: >- Indicates whether the request was processed successfully. Always `false` for an error response. type: boolean example: false error: description: Error details. properties: code: description: Machine-readable error code for programmatic handling. type: integer example: 401 message: description: Human-readable description of the error. type: string example: Unauthorized. Invalid or missing authentication credentials. type: object type: object BalanceInquiryErrorResponse404: description: >- Error response envelope for 404 Not Found responses from balance inquiry endpoints. Contains an error message and optional details. properties: status: description: HTTP status code. type: integer example: 404 success: description: >- Indicates whether the request was processed successfully. Always `false` for an error response. type: boolean example: false error: description: Error details. properties: code: description: Machine-readable error code for programmatic handling. type: integer example: 404 message: description: Human-readable description of the error. type: string example: Not found. The specified resource does not exist. type: object type: object BalanceInquiryErrorResponse405: description: >- Error response envelope for 405 Method Not Allowed responses from balance inquiry endpoints. Contains an error message and optional details. properties: status: description: HTTP status code. type: integer example: 405 success: description: >- Indicates whether the request was processed successfully. Always `false` for an error response. type: boolean example: false error: description: Error details. properties: code: description: Machine-readable error code for programmatic handling. type: integer example: 405 message: description: Human-readable description of the error. type: string example: >- Method not allowed. The specified resource exists but the authenticated merchant is not authorized to access it. type: object type: object InquiryBalanceMerchantData: description: >- Merchant-level balance snapshot returned by `InquiryBalanceTransformer` when `kind` is `top-level`. All monetary fields use the `MoneyAmount` schema. required: - held_balance - available_balance - pending_balance - balance properties: held_balance: $ref: '#/components/schemas/MoneyAmount' description: Funds reserved or on hold and not available for withdrawal. available_balance: $ref: '#/components/schemas/MoneyAmount' description: Funds available for immediate use or withdrawal. pending_balance: $ref: '#/components/schemas/MoneyAmount' description: >- Transactions that are pending settlement and not yet reflected in available balance. balance: $ref: '#/components/schemas/MoneyAmount' description: >- Total ledger balance (sum of available, held and pending as applicable). type: object MoneyAmount: description: >- A monetary value paired with its currency. Used for every balance field returned by the balance inquiry endpoints. required: - value - currency properties: value: description: >- Monetary amount represented as a decimal string, with two decimal places to preserve cents. type: string example: '1234.56' currency: description: ISO 4217 currency code. Always `IDR`. type: string example: IDR type: object securitySchemes: BearerAuth: type: http description: >- JWT issued by `POST /api/v1.1/access-token/b2b`. Send `Authorization: Bearer `. bearerFormat: JWT scheme: bearer PartnerId: type: apiKey description: Merchant API key (`Credential.api_key`). Required on every request. name: X-PARTNER-ID in: header ````