Get Brand Wallet Balance

POST/payment-option/wallet/balance

Retrieves the current balance of a customer's brand wallet, including breakdown by bucket type (e.g. CASH, PROMOTIONAL).

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Header Parameters

Field	Details
`Request-Timestamp` `string`date-time	ISO 8601 UTC timestamp of the request. Used for idempotency and audit.
`Request-ID` `string`	Use a global unique identifier [GUID] for the request. Constraints Minimum length: 1 characterMaximum length: 50 characters

Request Bodyrequired

Field	Details
`notes` `string`
`customers` `object`required9 nested fields	Customer whose wallet balance to check (customer_id required)

Response

Field	Details
`total_balance_amount` `object`2 nested fields	Total wallet balance
`value` `integer`required	Amount in the smallest currency unit (e.g., paisa for INR). Constraints Minimum value: 100Maximum value: 50000000000
`currency` `string`required	Three-letter ISO 4217 currency code. Constraints Default value: INR
`number_of_pin_attempts_allowed` `integer`	Remaining PIN attempts before lockout
`created_at` `string`date-time	Wallet creation timestamp
`native_currency` `string`	Primary currency of the wallet
`buckets` `BrandWalletBalanceBucket[]`5 nested fields	Balance breakdown by bucket type

Status Codes

`200`	Balance retrieved.
`400`	The request was malformed or missing required fields.
`401`	Authentication failed — missing, expired, or invalid Bearer token.
`500`	An unexpected error occurred on the server.

Run

Request

curl --request POST \
  --url https://pluraluat.v2.pinepg.in/payment-option/wallet/balance \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --header 'Request-ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Request-Timestamp: 2024-10-01T10:30:00Z' \
  --data '{
  "customers": {
    "email_id": "john@example.com",
    "first_name": "Kevin",
    "last_name": "Bob",
    "customer_id": "123456",
    "mobile_number": "9876543210",
    "country_code": "91",
    "billing_address": {
      "address1": "10 Downing Street Westminster London",
      "address2": "Oxford Street Westminster London",
      "address3": "Baker Street Westminster London",
      "pincode": "51524036",
      "city": "Westminster",
      "state": "Westminster",
      "country": "London",
      "full_name": "Kevin Bob",
      "address_type": "Home",
      "address_category": "billing"
    },
    "shipping_address": {
      "address1": "10 Downing Street Westminster London",
      "address2": "Oxford Street Westminster London",
      "address3": "Baker Street Westminster London",
      "pincode": "51524036",
      "city": "Westminster",
      "state": "Westminster",
      "country": "London",
      "full_name": "Kevin Bob",
      "address_type": "Home",
      "address_category": "billing"
    },
    "is_edit_customer_details_allowed": false
  }
}'

Status:

{
  "total_balance_amount": {
    "value": 150000,
    "currency": "INR"
  },
  "number_of_pin_attempts_allowed": 3,
  "created_at": "2026-01-15T10:30:00Z",
  "native_currency": "INR",
  "buckets": [
    {
      "currency_code": "INR",
      "number_of_cards": 2,
      "balance": 150000,
      "type": "CASH",
      "payment_instruments": []
    }
  ]
}