---
title: "Adds an order gift card payment to an in progress order base"
method: POST
path: "/ocapi/v1/orders/{orderId}/payments/gift-cards"
tags: ["Gift Cards"]
---

# Adds an order gift card payment to an in progress order base

`POST /ocapi/v1/orders/{orderId}/payments/gift-cards`

## Request

- Base URL: `https://developer.vista.co` (the document declares no server; this is the origin it was published from)
- URL: `https://developer.vista.co/ocapi/v1/orders/{orderId}/payments/gift-cards`
- Auth: none declared
- TypeScript: <https://skmtc.dev/vista/apis/vista-digital-platform/docs/ocapi/v1/orders/:orderId/payments/gift-cards/post.ts> (a function with typed inputs; its response is checked against the schema)

Payment details are stored against order and processed when order is complete.
#### Licenses Required


- Vista.Ocapi

## Path parameters

- `orderId` string, required

## Headers

- `Connect-Region-Code` string

## Request body

- OcapiV1OrdersPaymentsGiftCardsOrderGiftCardPaymentCreate: Represents the values required to create an order gift card payment
  - `cardNumber` string, required: Gets the card number
  - `pin` string, nullable: Gets the PIN

## Response `200`

Success

- OcapiV1OrdersPaymentsGiftCardsOrderGiftCardPayment: Represents a gift card payment that has been added to an order base
  - `id` string, required: Gets the identifier that can be used to uniquely identify the payment within the order base
  - `type` 'CinemaProcessed' | 'Embedded' | 'GiftCard' | 'Redirect' | 'MemberBalance' | 'ExternallyProcessed' | 'PaymentCard', required: Represents the type of an order payment base
  - `maskedCardNumber` string, required: Gets a masked representation of the card number
  - `value` number, double, required: Gets the monetary value
  - `status` 'NotStarted' | 'Pending' | 'Declined' | 'Completed', required: Represents the status of an order payment base

## Other responses

- `400`: Request property is invalid or missing, or gift card cannot be added.
- `404`: Order does not exist.
- `429`: Too many requests. Try again later.

## Changes

- **2026-10-09** `41415d239083`: 1 warning
  - added the new `PaymentCard` enum value to the `type/allOf[subschema #1: OrderPaymentType]/` response property for the response status `200`

[Operation history](https://skmtc.dev/vista/apis/vista-digital-platform/changes/ocapi/v1/orders/:orderId/payments/gift-cards/post.md)

---

[API](https://skmtc.dev/vista/apis/vista-digital-platform.md) - [All operations](https://skmtc.dev/vista/apis/vista-digital-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/vista/apis/vista-digital-platform/revisions/c46f30854000?raw)