POST /v2/loyalty/rewards/{reward_id}/redeem
Redeems a loyalty reward.
The endpoint sets the reward to the REDEEMED terminal state.
If you are using your own order processing system (not using the Orders API), you call this endpoint after the buyer paid for the purchase.
After the reward reaches the terminal state, it cannot be deleted. In other words, points used for the reward cannot be returned to the account.
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
reward_id |
String | Yes |
The ID of the loyalty reward to redeem. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
location_id |
String | Yes |
The ID of the location where the reward is redeemed. |
idempotency_key |
String | Yes |
A unique string that identifies this |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.