Redeem Points
Use the Redeem Points API endpoint to submit a request to redeem points as a credit against a customer's line of credit account.
ImportantCertain 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 Redeem Points endpoint enables you to redeem part of a customer's rewards points balance as a statement credit on their line of credit account. You specify the amount of statement credit to apply, in creditAmount. On a successful redemption request, Thredd applies the credit to the account and deducts the equivalent points from the customer's points balance.
NoteStatement credit is currently the only supported redemption method. Automatic redemption is not supported, so customers must ask to redeem their points. For more information, see Rewards.
More InformationFor more information about the Rewards endpoints, see: Rewards. To correct a customer's points balance instead of redeeming points, use the Adjust Rewards Points endpoint.
Prerequisites
To integrate calls to the Redeem Points endpoint, you need:
- The
account_idof 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.
- The customer must have enough unredeemed points to cover the credit amount. Before you submit a redemption request, use the Get Rewards Balance endpoint to retrieve the
rewardValue, which is the statement credit value of the customer's available points.
Example Request
Redeem points by making a POST request to the Redeem Points endpoint.
POST {{baseUrl}}/api/v1/credit/explorer/accounts/{account_id}/rewards/redeem
Path Parameters
| Parameter | Description |
|---|---|
account_id | string. Required. The unique identifier of the line of credit account. |
Example Payload
{
"creditAmount": 0,
"description": "string"
}{
"creditAmount": 5,
"description": "Statement credit requested via app"
}Request Fields
| Attribute | Description |
|---|---|
creditAmount | integer. Required. The amount of statement credit to redeem. Must be a positive whole number and must not exceed the rewardValue returned by Get Rewards Balance. |
description | string. Required. A description of the redemption. Between 1 and 250 characters. Passed through to the loan management system. |
Example Response
A successful request returns a 200 HTTP status code confirming the redemption has been processed.
NoteIf the request contains invalid data or the customer has insufficient points, the system returns a
422HTTP error and details of the validation failure.
{
"redemptionReference": 987654
}{
"detail": "Account with the specified ID does not exist"
}{
"detail": [
{
"loc": ["body", "creditAmount"],
"msg": "Field required",
"type": "missing"
}
]
}Response Fields
| Attribute | Description |
|---|---|
redemptionReference | integer. The reference identifier for this redemption, as confirmed by the loan management system. |
To see the points deducted, call Get Rewards Balance again, or look for the redemption in Get Account Transactions, where it appears as a credit transaction with a negative rewardPoints value.
Updated 7 days ago
