---
title: "Gets the order maximum member balance payment for an in progress order base"
method: GET
path: "/ocapi/v1/orders/{orderId}/payments/maximum-member-balance"
tags: ["Members"]
---

# Gets the order maximum member balance payment for an in progress order base

`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)
- URL: `https://developer.vista.co/ocapi/v1/orders/{orderId}/payments/maximum-member-balance`
- 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)

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

## Path parameters

- `orderId` string, required

## Headers

- `loyaltySessionToken` string
- `Connect-Region-Code` string

## Response `200`

Success

- OcapiV1OrdersPaymentsMemberBalanceMaximumOrderMaximumMemberBalancePaymentDetails: Represents an order maximum member balance payment entity, and its related data
  - `payment` OcapiV1OrdersPaymentsMemberBalanceMaximumOrderMaximumMemberBalancePayment, required: Represents the maximum order member balance payment value for an in progress order base
    - `balanceTypeId` integer, required: Gets the unique identifier of the balance type
    - `maximumValue` number, double, required: Gets the maximum eligible monetary value
    - `maximumUnits` number, double, required: Gets the maximum eligible value in balance type units
    - `availableUnits` number, double, required: Gets the total available member balance units, including those not eligible to be used as payment for the in progress order base
  - `relatedData` OcapiV1OrdersPaymentsMemberBalanceMaximumOrderMaximumMemberBalancePaymentRelatedData, required: Related data for an order maximum member balance payment entity
    - `balanceType` OcapiV1LoyaltyBalanceTypesBalanceType, required: Represents an account in Vista Loyalty that tracks the spending or activity of a member
      - `id` integer, required: Gets the unique identifier
      - `name` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required: Gets the text in the default language
        - `translations` OcapiV1Translation[], required: Gets the translations of the translatable Text in other languages
          - `languageTag` string, required: Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required: Gets the translated text
      - `isPrimary` boolean, required: Gets a value indicating whether this is the primary balance type
      - `unitName` string, nullable: Gets the name of the balance units
      - `paymentConversionRate` number, double, nullable: Gets the conversion rate that applies when using balance units for an order member balance payment, if applicable
      - `unitDecimalPlaces` integer, required: Gets the number of decimal places used to format and calculate balance unit values

## Other responses

- `204`: Member has no card, or does not have a supported balance type.
- `401`: No member signed in.
- `404`: Order does not exist.

---

[API](https://skmtc.dev/vista/apis/vista-digital-platform.md) - [All operations](https://skmtc.dev/vista/apis/vista-digital-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/vista/apis/vista-digital-platform/revisions/c46f30854000?raw)