Get Rewards Balance

Use the Get Rewards Balance API endpoint to retrieve the current unredeemed points balance for a customer's line of credit account.

📘

Important

Certain Credit API endpoints are in a draft status and are subject to change without notice. Thredd may modify interfaces, behaviour, and documentation as development continues.

The Get Rewards Balance endpoint enables you to retrieve a customer's current unredeemed points balance, and the value of those points as a statement credit. Use this endpoint to surface the points balance within your customer interface, such as a mobile app or web portal, and to check how much statement credit a customer can redeem with the Redeem Points endpoint.

📘

More Information

For more information about the Rewards endpoints, see: Rewards.

Prerequisites

To integrate calls to the Get Rewards Balance endpoint, you need:

  • The account_id of the line of credit account. This is the Thredd Account ID, returned when a credit application is approved.
  • The account must be part of a rewards-enabled product.

Example Request

Retrieve the rewards balance by making a GET request to the Get Rewards Balance endpoint.

GET {{baseUrl}}/api/v1/credit/explorer/accounts/{account_id}/rewards/balance

Path Parameters

ParameterDescription
account_idstring. Required. The unique identifier of the line of credit account.

Example Response

A successful request returns a 200 HTTP status code with the current unredeemed points balance for the account, its statement credit value and the redemption rate.

{
  "availablePoints": 1250,
  "rewardValue": 12.5,
  "redemptionRate": 0.01
}
{
  "detail": "Account with the specified ID does not exist"
}

Response Fields

AttributeDescription
availablePointsnumber. The total unredeemed rewards points available on the account.
rewardValuenumber. The statement credit value of the available points. This is the most the customer can redeem.
redemptionRatenumber. The rate used to calculate the reward value from the reward points.

Did this page help you?