Sign in

v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Members

Sets the order member balance payment for an in progress order base

The currently authenticated member must have a member card and a supported balance type in order to make a member balance payment.

Licenses Required

  • Vista.Ocapi
put/ocapi/v1/orders/{orderId}/payments/member-balance

Path parameters

orderIdstring required

The unique identifier of the in progress order base that the payment is for

Headers

loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

Request body

valuenumber double nullable

Gets the monetary value, if applicable

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

valuenumber double required

Gets the monetary value

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

Represents the status of an order payment base

balanceTypeIdinteger required

Gets the unique identifier of the balance type

unitsnumber double required

Gets the value in balance type units