v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB

Members

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

get/ocapi/v1/orders/{orderId}/payments/maximum-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

Response

Success

Example response

{
  "relatedData": {
    "balanceType": {
      "name": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      },
      "unitName": "Points"
    }
  }
}