Skip to main content
GET
Wallet balance for Account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_id
string
required

account_id corresponding to an account

Maximum string length: 50
Example:

"ACC00001"

Response

Response for Credit Balance Request

Wallet Balance response

id
string
required
accountId
string
required
Example:

"ACC001"

customerId
string
required
Example:

"ACC001"

balance
number
required

This amount is the difference of total credited amount and sum of consumed, hold amount. ie. credit amount - (consumed amount + hold amount)

Example:

500

creditUnit
string
required
Example:

"USD"

status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
effectiveFrom
string<date-time>
required
externalId
string
holdAmount
number
Example:

500

createdAt
string<date-time>
updatedAt
string<date-time>
metadata
object