---
updatedAt: 2026-06-23T08:14:20.000Z
agentTools:
  projectIndex: https://dev-scp.splio.com/llms.txt
---

# Use a reward granted to a loyalty member.

Use a reward granted to a loyalty member.

# Error cases

## Reward attribution id does not exist (404)

```json
{
    "error_key": "external_id",
    "error": "external_id_not_found",
    "error_description": "no reward attribution {id} found"
}
```

## store\_id does not exist (404)

```json
{
    "status": 404,
    "errors": {
        "error_key": null,
        "error": "not_found",
        "error_description": "extid \"test_store_id\" not found in splio3_ecommerce.qa03_stores"
    }
}
```

## Reward attribution already burned (400)

```json
{
    "error_key": "external_id",
    "error": "external_id_already_burned",
    "error_description": "reward attribution 88317113 already burned at 2023-01-01 00:00:00"
}
```

## Cardcode does not exist (or not valid at target burned\_date) (400)

```json
{
    "error_key": "card_code",
    "error": "card_code_not_found",
    "error_description": "no membership found for cardcode test on the 2023-07-18 19:15:01"
}
```

## Cardcode does not match the attribution’s cardcode (400)

```json
{
    "error_key": "card_code",
    "error": "inconsistent_card_code",
    "error_description": "the given cardcode 2673935406285 does not match the card_code of the given reward attribution 18374174"
}
```

## Burned\_date inconsistency with attribution dates (400)

```json
{
    "error_key": "burned_date",
    "error": "inconsistent_dates",
    "error_description": "burn date should be after earned date 2018-01-12 15:00:00"
}
```

```json
{
    "error_key": "burned_date",
    "error": "inconsistent_dates",
    "error_description": "burn date should be before expiration date 2050-01-01 00:00:00"
}
```

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "x-origin": [
    {
      "url": "https://api.splio.com/doc.json",
      "format": "swagger",
      "version": "2.0",
      "converter": {
        "url": "https://github.com/mermade/oas-kit",
        "version": "7.0.8"
      }
    }
  ],
  "info": {
    "title": "Splio Customer Platform",
    "description": "API Documentation for Splio Customer Platform",
    "version": "1.0.0"
  },
  "paths": {
    "/loyalty/v1/reward-attributions/{id}/burn": {
      "post": {
        "summary": "Use a reward granted to a loyalty member.",
        "description": "Use a reward granted to a loyalty member.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "Reward grant unique external identifier.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "card_code": {
                    "description": "Use this if you have loyalty feature.",
                    "example": "44010000002",
                    "type": "string"
                  },
                  "contact_id": {
                    "description": "Use this if you have the new couponing feature.",
                    "example": "13465",
                    "type": "string"
                  },
                  "reason_msg": {
                    "example": "Catching up summer's free cake offer.",
                    "type": "string"
                  },
                  "burned_date": {
                    "example": "2018-01-12 15:00:00",
                    "type": "string",
                    "pattern": "^\\d\\d\\d\\d-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01]) (00|[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$"
                  },
                  "store_id": {
                    "example": "store01",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "description": "Use a reward granted to a loyalty member.",
          "required": true
        },
        "responses": {
          "200": {
            "description": "Reward use is successful.",
            "content": {
              "application/json": {
                "examples": {
                  "response": {
                    "value": {
                      "external_id": "1006087183901",
                      "card_code": "8393566595977",
                      "program_name": "Corgi club",
                      "earned_date": "2021-02-19 18:00:54",
                      "status": "burned",
                      "burned_date": "2021-03-10 17:43:38",
                      "expiration_date": "2022-02-19 18:00:54",
                      "store_id": null,
                      "interaction_details": "Attribution of the reward",
                      "interaction_type": "reward_attribution",
                      "reason_msg": "",
                      "reward_definition": {
                        "name": "RewardStock1",
                        "external_id": "RewardStock1",
                        "monetary": false,
                        "monetary_type": "value",
                        "monetary_value": 0,
                        "nqp_value": 0,
                        "image_url": ""
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request validation failed.",
            "x-readme": "BODYBODY",
            "content": {
              "application/json": {
                "examples": {
                  "response": {
                    "value": {
                      "status": 400,
                      "errors": [
                        {
                          "error_key": "field_1",
                          "error": "wrong_value",
                          "error_description": "The request was malformed and it is unable to be processed. Please review and try again."
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed."
          },
          "403": {
            "description": "Forbidden."
          },
          "404": {
            "description": "Granted reward with this identifier not found.",
            "content": {
              "application/json": {
                "examples": {
                  "response": {
                    "value": {
                      "status": 404,
                      "errors": [
                        {
                          "error_key": "id",
                          "error": "wrong_value",
                          "error_description": "Reward attribution not found for given identifier."
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Reward"
        ],
        "security": [
          {
            "Bearer": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.splio.com"
    },
    {
      "url": "http://api.splio.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "description": "For accessing the API a valid JWT token must be passed in all requests in\nthe 'Authorization' header.\n\n\nA valid JWT token is generated by the Authorization API and returned as answer of a call\nto the route /authenticate giving a valid user, password & universe.\n\n\nThe following syntax must be used in the 'Authorization' header :\n\n    Bearer xxxxxx.yyyyyyy.zzzzzz\n",
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}
```