GET /loyalty/balance/programs/{pid}/transaction-history

Returns transaction history

Servers

Path parameters

Name Type Required Description
pid String Yes

Loyalty Program Id

Query parameters

Name Type Required Description
limit Integer No

Limit the number of records returned

sortField String No

Field to sort by

Valid values:

  • "createdAt"

Default value: "createdAt"

transactionType String No

Transaction type filter

Valid values:

  • "credit"
  • "debit"
sort String No

Sort order

Valid values:

  • "desc"
  • "asc"
balanceDefinitionId String Yes

Balance Definition ID

loyaltySubscriptionId String No

Loyalty Subscription ID filter

status String No

Transaction status filter

Valid values:

  • "completed"
  • "rejected"
  • "expired"
  • "draft"
  • "cancelled"
contactId Integer Yes

Contact ID

offset Integer No

Page number to retrieve

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.