---
title: "Collect invoice payment by redeeming a guest's gift card"
method: POST
path: "/v1/invoices/{invoice_id}/payments/gift_card"
---

# Collect invoice payment by redeeming a guest's gift card

`POST /v1/invoices/{invoice_id}/payments/gift_card`

This API helps you to collect payment for the amount of an invoice by redeeming the balance of a guest’s gift card.

You must first verify the balance of a guest’s gift card. If the gift card contains sufficient balance, you can then call this API to collect payment for the specified invoice.

This gift card redemption for an invoice enables you to display the relevant details in your Zenoti UI, and map it to the respective fields in Reports and Analytics.

You must specify appropriate data for the `invoice_id` parameter.

## Path parameters

- `invoice_id` string, required

## Response `200`

200

- object
  - `is_applied` boolean
  - `payment` object
    - `payment_option` object
      - `id` string
      - `payment_mode` integer
      - `payment_name` string
      - `card_number` string
      - `additional_data` unknown
    - `total_amount_paid` integer
    - `amount_paid` integer
    - `tip_amount` integer
    - `ssg_amount` integer
    - `fee_amount` integer
    - `cash_back_amount` integer
    - `transaction_id` string
    - `payment_date` string
    - `cash_regester_id` string
  - `error` object
    - `code` integer
    - `message` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/zenoti/apis/zenoti-authentication.md) · [All operations](https://skmtc.net/zenoti/apis/zenoti-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenoti/zenoti-authentication/revisions/e628f892391a/schema)