Gets the order maximum 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

Responses
200

Success

204

Member has no card, or does not have a supported balance type.

401

No member signed in.

404

Order does not exist.

get/ocapi/v1/orders/{orderId}/payments/maximum-member-balance
Request samples 
Response samples 
application/json
{
  • "payment": {
    },
  • "relatedData": {
    }
}