Skip to main content
POST
Check Availability
Queries a member’s current redeemable points balance in real time. Always call this before Redeem Points to confirm the member has sufficient balance. Partial redemption is not supported — members must redeem points covering the full transaction value. The points-to-currency conversion rate is configurable per program; confirm the rate for your program with your Xoxoday implementation contact to correctly calculate how many points equal the cart value.

Responses


Error Codes

Authorizations

Authorization
string
header
required

JWT obtained from Generate Auth Token. Pass as Authorization: bearer {token}.

Body

application/json
RelationReference
string
required
Example:

"jane.doe@example.com"

TransactionCurrency
string
required
Example:

"DEFAULT"

RelationType
integer
required

Use 4 for customers

Example:

4

ProgramId
integer
required
Example:

19

Response

200 - application/json

Balance retrieved

results
object