Sign in

v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Gift Cards

Adds a gift card payment to the order

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

Licenses Required

  • Vista.Ocapi
post/ocapi/v1/orders/{orderId}/payments/gift-cards

Path parameters

orderIdstring required

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

Headers

Connect-Region-Codestring

Region Code

Request body

cardNumberstring required

Gets the card number

pinstring nullable

Gets the PIN

Response

Success

idstring required

Gets the identifier that can be used to uniquely identify the payment within the order base

type'CinemaProcessed' | 'Embedded' | 'GiftCard' | 'Redirect' | 'MemberBalance' | 'ExternallyProcessed' required

Represents the type of an order payment base

maskedCardNumberstring required

Gets a masked representation of the card number

valuenumber double required

Gets the monetary value

status'NotStarted' | 'Pending' | 'Declined' | 'Completed' required

Represents the status of an order payment base

Example response

{
  "maskedCardNumber": "12.......6789"
}