v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Lookup Customer Transactions

Retrieve a list of transactions for a specific customer based on identifiers and filters.

get/v2/customers/lookup/transactions

Query parameters

identifierNamestring required

Example:mobile

The name of the identifier (e.g., mobile, email).

identifierValuestring required

Example:918088369835

The value of the identifier.

sourcestring required

Example:INSTORE

The source of the transaction.

transactionTypestring

Example:REGULAR

The type of transaction.

startDatestring date

Example:2025-01-01

Transaction start date in the format YYYY-MM-DD HH:MM:SS.

endDatestring date

Example:2025-12-31

Transaction end date in the format YYYY-MM-DD HH:MM:SS.

localCurrencyboolean

Whether to return values in local currency.

transactionIdinteger

Example:894749264

Unique transaction ID used to retrieve transaction details.

numberstring

Example:txn-118

Filter by transaction number.

startIdinteger

Example:1000

A unique transaction ID from which the system starts retrieving transaction details.

endIdinteger

Example:2000

A unique transaction ID up to which the system retrieves transaction details.

entityTypestring

Example:STORE

Specifies the level of the store hierarchy to apply the filter.

entityCodestring

Example:STORE_001

Specifies the unique identifier of the entity selected in entityType.

sortOrder'ASC' | 'DESC'

Example:DESC

Order in which records are sorted. ASC and DESC are supported values.

limitinteger

Example:20

Maximum number of records to retrieve. Maximum limit: 1000

offsetinteger

Starting point for records retrieval

embedstring

Example:BILL_CF,BILL_EF,ATTRIBUTION,PAYMENT_MODES,CREDIT_NOTES,BILL_STORE_DETAILS,BILL_POINTS,TRANSACTION_IDENTIFIER

Retrieves details for the selected embed parameters. Allowed: BILL_CF, BILL_EF, BILL_STORE_DETAILS, PAYMENT_MODES, ATTRIBUTION, CREDIT_NOTES, BILL_POINTS

Response

Successful response

object required