---
title: "Redeem Points"
method: POST
path: "/points/redeem"
---

# Redeem Points

`POST /points/redeem`

This API enables you to redeem points of a customer.

## Query parameters

- `format` 'xml' | 'json'

## Request body

- object
  - `root` object
    - `redeem` object — Redeem details
      - `points_redeemed` string — Points to be redeemed from the customer.
      - `transaction_number` string — Transaction number of the transaction.
      - `customer` object — Mobile number is a mandatory field.
        - `mobile` string, required — Mobile number of the customer.

## Response `200`

200

- object
  - `response` object
    - `status` object
      - `success` string
      - `code` integer
      - `message` string
    - `responses` object
      - `points` object
        - `mobile` string
        - `email` string
        - `external_id` string
        - `user_id` string
        - `redemption_id` string
        - `points_redeemed` string
        - `redemption_purpose` string
        - `redeemed_value` integer
        - `redeemed_local_value` integer
        - `balance` integer
        - `side_effects` object
          - `effect` object[]
            - `id` integer
            - `case_value` string
            - `num_points` integer
            - `currency_value` integer
            - `validation_code` string
            - `points_redemption_summary_id` string
            - `redeemed_on_bill_number` string
            - `redeemed_on_bill_id` integer
            - `type` string
        - `item_status` object
          - `success` string
          - `code` integer
          - `message` string

## 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/revisions/de241f2ed9b3/schema)