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
Request
path Parameters
orderId
required
string

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

header Parameters
loyaltySessionToken
string

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

Connect-Region-Code
string

Region Code

Request Body schema:
required

The member balance payment request

value
number or null <double>

Gets the monetary value, if applicable

Responses
200

Success

400

Member has no card, or a non-positive value was specified.

401

No member signed in.

put/ocapi/v1/orders/{orderId}/payments/member-balance
Request samples
{
  • "value": 0.1
}
Response samples
application/json
{
  • "id": "string",
  • "type": "CinemaProcessed",
  • "value": 0.1,
  • "status": "NotStarted",
  • "balanceTypeId": 0,
  • "units": 0.1
}