VIvista
Gift Cards

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

Changed on

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

Licenses Required

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

Request

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' | 'PaymentCard' 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"
}

Changes

  • 41415d239083Revision changes
    • warning

      added the new PaymentCard enum value to the / response property for the response status