Get Customer Ledger Balance

get

https://{host}/v2/pointsLedger/getCustomerLedgerBalance

Retrieves category-wise points’ ledger balance details of a customer for a given time.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

identifierName

string

enum

required

Identifier type to identify the customer.

Allowed:

identifierValue

string

required

Value of the specified identifier type of the customer.

source

string

enum

required

Source in which the identifier is available.

accountId

string

For sources with multiple accounts, pass the specific accountId in which the identifier is registered.

tillId

string

Get the customer’s ledger balance of a specific TILL. Pass the unique till ID.

limit

int32

Defaults to 10

Number of results to retrieve. Max value supported is also 10.

offset

int32

Defaults to 0

Number of pages to be ignored from the top (page number).

endDate

string

Get the closing balance of a specific date. Pass the end date in YYYY-MM-DDThh:mm:ss format. Default value, startDate plus 7 days.

includeTillConceptEvents

boolean

Defaults to false

Fetches the deduction entries that were triggered at the tills mapped to the Concept of the Program ID even if the deductions are from a different program.

ledgerEntryType

string

enum

Specify the type of ledger entries you want to fetch. By default, it fetches all the ledger entry types.

Allowed:

pointCategoryType

string

enum

Specify the point category type for which you want to fetch ledger details. By default, it fetches all the points category details.

Allowed:

alternateCurrencyNames

string

Pass includeAlternateCurrencies=true to retrieve all alternate currencies of the customer.

includeAlternateCurrencies

boolean

Pass includeAlternateCurrencies=true to retrieve all alternate currencies available with the customer.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400