BETA: Please note that the current endpoints are considered beta. It is possible there may be changes before these endpoints are finalised.

Points

Adjust customers points balance

Add or remove points from a customers points balance.

put /organizations/{organizationId}/customers/{customerId}/points/{reference}

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
customerIdstringpathUnique ID of the Customer
referencestringpathUnique identifier from service requesting point adjustment

Request Body

PointsAdjustmentPayload
{
  "amount": 5,
  "notes": "Manual adjustment using api"
}

Responses

204: No Content response.
409: Conflict response.

Reverse points

Revert previous addition or removal of points using reference.

delete /organizations/{organizationId}/customers/{customerId}/points/{reference}

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
customerIdstringpathUnique ID of the Customer
referencestringpathUnique identifier from service requesting point adjustment

Request Body

PointsReversalPayload
{
  "notes": "Manual adjustment reversal using api"
}

Responses

204: No Content response.
409: Conflict response.

Models

PointsAdjustmentPayload

Adjust point payload

NameTypeDescription
amountinteger Points to be added or removed from customer's point balance. Amount must be negative to remove points and positive to add points. e.g. 5, -14
notesstring(optional) Note for points change history.

PointsReversalPayload

Reverse point payload

NameTypeDescription
notesstring Note for points change history.

In this article