Skip to content

Redeem credits

Request

Forwards a redemption request to the Inveterate backend. Returns the success status of the request against the backend service. Like the other endpoints that make requests against our backend, the changes may not take effect immediately.

Security
api_key
Path
idstringrequired

The customer ID number.

Bodyapplication/jsonrequired
amountnumberrequired

The amount of credits to be added to or removed from the customer's account. It can't be zero

notestring

Optional note to be associated with this credit transaction

forceboolean

When force: true is included with a negative credit amount, this will disable any active credit redemption discount codes when necessary.

curl -i -X POST \
  'https://public.inveterateapi.com/v2.0/storefront/members/{id}/credits/redemption' \
  -H 'Content-Type: application/json' \
  -H 'X-Inveterate-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "amount": 0,
    "note": "string",
    "force": true
  }'

Responses

Returned upon successful request made to our backend. Requests that return this code may take a small amount of time after successful API return to fully update.

Bodyapplication/json
messagestringrequired

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

dataobjectrequired

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

Response
{
  "message": "Request sent successfully",
  "data": {
    "id": 1,
    "name": "John Doe"
  }
}