Get group transactions

get

https://{host}/v2/userGroup2/transactions

Retrieves the transactions of a specific group. You can also get transactions of a group member using query parameters.

Query Params

type

string

enum

Type of the transaction to retrieve.

Allowed:

int32

Unique ID of the user group to fetch transactions.

externalId

string

External ID of the group.

primaryUserId

string

User ID of the primary member of the group.

identifierName

string

enum

Identifier used for the primary user of the group. Required to get transactions of the group member.

Allowed:

identifierValue

string

Value of the specified identifier type.

source

string

enum

Source in which the identifier is available.

accountId

string

Account ID for sources with multiple accounts such as FACEBOOK, WEBENGAGE, WHATSAPP. Applicable to fetch member transactions.

transactionId

int32

Fetch details of a specific transaction by transaction ID.

billNumber

string

Fetch details of a specific transaction by bill number.

customerId

int64

Unique ID of the group member to fetch group transactions made by the customer.

startDate

date

Filter results where transaction_date >= startDate. Pass ISO standard date format.

endDate

string

Filter results where transaction_date < end_date. Pass ISO standard date format.

embed

string

enum

Additional details to be fetched. You can pass multiple values each separated by a comma. PAYMENTDETAILS is supported only for regular transaction.

Allowed:

getDataForAllPrograms

boolean

Pass true to fetch transactions across all programs data (future use case).

offset

int32

Offset of the first entry in the result. This should be positive. If offset is less than 0, then 0 default offset will be used.

limit

int32

Defaults to 20

Maximum number of results to show. This should be positive. if limit is less <=0, then the default limit 20 is considered.

order

string

enum

Defaults to DESC

Arranges the transactions based on the value set in sort in an ascending (asc) or descending order (desc). By default, results are shown in the descending order of transactionDate.

Allowed:

creditNotes

boolean

Pass true to fetch credit notes details.

roles

string

Roles associated with the user.

Responses

200200

400400