Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • cash object Required
      Hide cash attributes Show cash attributes object
      • expirations array[object]
        Hide expirations attributes Show expirations attributes object
        • amount number(float) Required

          The amount that will expire in the smallest currency value. Example: 534

        • date string Required

          The date when the cash amount will expire. Example: "2030-01-01"

          Default value is 2030-01-01.

      • balanceAmount integer Required

        The amount that will expire in the smallest currency value. Example: 534

    • points object Required
      Hide points attributes Show points attributes object
      • balance number(float) Required
      • expirations array[object]
        Hide expirations attributes Show expirations attributes object
        • amount number(float) Required

          The amount of points that will expire at the given date

        • date string Required

          The date when the points will expire. Example: "2030-01-01"

GET /loyalty/get/wallet
Response examples (200)
{
  "cash": {
    "expirations": [
      {
        "amount": 42.0,
        "date": "2030-01-01"
      }
    ],
    "balanceAmount": 42
  },
  "points": {
    "balance": 42.0,
    "expirations": [
      {
        "amount": 42.0,
        "date": "string"
      }
    ]
  }
}