Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update coupon redeem field

put/coupon/redeem

Request body

redemptionsobject

Object containing redemption details.

redemptionIdinteger required

Unique identifier of the redemption.

billAmountinteger required

The amount of the bill associated with the redemption.

transactionNumberstring

Unique number identifying the transaction.

billIdinteger

Unique identifier for the bill associated with redemption.

userobject

An object representing the user.

mobilestring

The mobile number of the user.

Response

200

OR
OR
OR
OR

Example response

{
  "entity": {
    "redemptions": [
      {
        "redemptionId": 17130548,
        "billAmount": 1000,
        "transactionNumber": "txnNumberTest1605",
        "billId": 12344,
        "customFields": {
          "cf_key_1": "cf_value_1",
          "cf_key_2": "cf_value_2"
        },
        "redemptionStatus": {
          "code": 510,
          "message": "Invalid Redemption ids present"
        }
      }
    ],
    "user": {
      "id": 565039504,
      "profiles": [
        {
          "firstName": "Tom",
          "lastName": "Sawyer",
          "identifiers": [
            {
              "type": "email",
              "value": "tom.sawyer@capillarytech.com"
            }
          ],
          "userId": 565039504,
          "autoUpdateTime": "2025-05-20T10:34:17Z",
          "identifiersAll": [
            {
              "type": "email",
              "value": "tom.sawyer@capillarytech.com"
            }
          ]
        }
      ]
    },
    "status": {
      "code": 760,
      "message": "Coupon redeem update failed"
    },
    "totalCount": 1,
    "failedCount": 1
  },
  "errors": [
    {
      "code": 760,
      "message": "Coupon redeem update failed"
    }
  ]
}