Adds a gift card payment to the order

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

Licenses Required

  • Vista.Ocapi
Request
path Parameters
orderId
required
string

The unique identifier of the in progress order base that the payment will be added to

header Parameters
Connect-Region-Code
string

Region Code

Request Body schema:
required

The gift card payment request

cardNumber
required
string non-empty

Gets the card number

pin
string or null

Gets the PIN

Responses
200

Success

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.

post/ocapi/v1/orders/{orderId}/payments/gift-cards
Request samples
{
  • "cardNumber": "string",
  • "pin": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "type": "CinemaProcessed",
  • "maskedCardNumber": "12.......6789",
  • "value": 0.1,
  • "status": "NotStarted"
}