Adjust Rewards Points

Increase or decrease the rewards points balance on a 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 Adjust Rewards Points endpoint enables you to add points to, or remove points from, a customer's rewards balance outside the normal earning and redemption flow. For example, you might award goodwill points after a complaint, or correct a balance after points were credited in error.

Each adjustment changes the balance by the number of points you send. Thredd passes the adjustment to the loan management system, which records it as a rewards transaction against the account. The response returns the balance before and after the adjustment, so you can confirm the result straight away.

To redeem points as a credit to the account, use the Redeem Points endpoint instead.

📘

More Information

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

Prerequisites

To integrate calls to the Adjust Rewards Points 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.
  • If you're decreasing the balance, the customer's current points balance. Retrieve this using the Get Rewards Balance endpoint.

Example Request

Adjust a rewards balance by making a POST request to the Adjust Rewards Points endpoint.

POST {{baseUrl}}/api/v1/credit/explorer/accounts/{account_id}/rewards/adjust

Path Parameters

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

Example Payload

{
  "adjustmentType": "INCREASE | DECREASE",
  "adjustedPoints": 0,
  "description": "string",
  "applyDate": "YYYY-MM-DD"
}
{
  "adjustmentType": "INCREASE",
  "adjustedPoints": 500,
  "description": "Goodwill points for delayed card delivery",
  "applyDate": "2026-10-05"
}
{
  "adjustmentType": "DECREASE",
  "adjustedPoints": 200,
  "description": "Correction for duplicate points credit",
  "applyDate": "2026-10-05"
}

Request Fields

AttributeDescription
adjustmentTypestring. Required. Whether the adjustment increases or decreases the rewards points balance. Possible values: INCREASE, DECREASE.
adjustedPointsinteger. Required. The number of points to add or remove. Must be a positive integer. The adjustmentType decides whether points are added or removed.
descriptionstring. Required. A description of the adjustment, for example the reason for it. Between 1 and 250 characters. Passed through to the loan management system.
applyDatestring. Required. The date the adjustment applies to the account, in YYYY-MM-DD format.

Example Response

A successful request returns a 200 HTTP status code with the points balance before and after the adjustment.

📘

Note

If the request contains invalid data or is incomplete, the system returns a 422 HTTP error and details of the validation failure.

{
  "adjustmentReference": 482019,
  "transactionReference": 7730164,
  "pointsBalanceBefore": 12500,
  "pointsBalanceAfter": 13000
}
{
  "detail": "Account with the specified ID does not exist"
}
{
  "detail": [
    {
      "loc": ["body", "adjustedPoints"],
      "msg": "Input should be greater than 0",
      "type": "greater_than"
    }
  ]
}

Response Fields

AttributeDescription
adjustmentReferenceinteger. The reference for this adjustment, as confirmed by the loan management system.
transactionReferenceinteger. The reference for the rewards transaction created by the adjustment, as confirmed by the loan management system.
pointsBalanceBeforeinteger. The rewards points balance immediately before the adjustment.
pointsBalanceAfterinteger. The rewards points balance immediately after the adjustment.

Error Messages

If there is a problem with the request, the response returns one of the following errors:

  • 404 — The account_id provided does not match an existing account.
  • 422 — A required field or its value is missing or invalid. For example, adjustedPoints is 0 or negative, description is longer than 250 characters, or applyDate isn't a valid date. The response includes details of the validation failure.

Did this page help you?