---
title: "Redeem single coupon"
method: POST
path: "/coupon/redeem"
---

# Redeem single coupon

`POST /coupon/redeem`

This API allows you to redeem active coupons of a loyalty customer. You can pass multiple coupons at once.

## Request body

- object
  - `redemptionRequestList` object — Details of the coupon code to redeem.
    - `code` string, required — Coupon code to be redeemed.
  - `billAmount` number, float, required — Transaction amount of the bill.
  - `transactionNumber` string, required — Transaction number against which the coupon needs to be redeemed.
  - `code` string, required — Coupon code to redeem.
  - `user` object — Any identifier of the customer who wants to redeem coupons. Values: mobile, email, externalId
    - `mobile` string — Mobile number of the customer.
    - `email` string — Email ID of the customer.
    - `cardnumber` string — Card number of the customer.
    - `externalId` string — External ID of the customer
    - `cardExternalId` string — External ID of the card.
  - `redemptionTime` string, date — Date and time of redemption in YYYY-MM-DD HH:MM:SS format. The time defined here is used for certain evaluations, but it is not stored in the system. The system considers the store's current time as the redemption time.

## Response `200`

200

- object
  - `redemption` object[]
    - `id` integer
    - `currencyInput` boolean
    - `localToBaseCurrencyExchangeRate` integer
    - `warnings` unknown[]
      - unknown
    - `appendedErrorMessage` string
    - `code` string
    - `discountCode` string
    - `seriesCode` integer
    - `isAbsolute` boolean
    - `couponValue` integer
    - `redemptionStatus` object
      - `statusCode` object
        - `status` boolean
        - `message` string
        - `code` integer
      - `warnings` unknown[]
        - unknown
      - `warningsAsStatusCode` unknown[]
        - unknown
      - `message` string
      - `code` integer
      - `success` boolean
    - `discountType` string
    - `discountValue` integer
    - `discountUpto` integer
  - `redemptionStatus` object
    - `status` boolean
    - `message` string
    - `code` integer
  - `customer` object
    - `id` integer
    - `profiles` object[]
      - `firstName` string
      - `lastName` string
      - `fields` object
      - `identifiers` object[]
        - `type` string
        - `value` string
      - `commChannels` unknown[]
        - unknown
      - `userId` integer
      - `accountId` string
      - `autoUpdateTime` string
      - `identifiersAll` object[]
        - `type` string
        - `value` string
  - `warnings` unknown[]
    - unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/versions/de241f2ed9b3/schema)