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

Request

Base URL
https://developer.vista.co (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/vista/apis/vista-digital-platform/docs/ocapi/v1/orders/:orderId/payments/maximum-member-balance/get.ts
A function with typed inputs. Its response is checked against the schema.

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

Changes

No recorded changes to this operation across all 5 revisions of this API.