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

# Sets the order member balance payment for an in progress order base

`PUT /ocapi/v1/orders/{orderId}/payments/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/member-balance`
- Auth: none declared
- TypeScript: <https://skmtc.dev/vista/apis/vista-digital-platform/docs/ocapi/v1/orders/:orderId/payments/member-balance/put.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

## Request body

- OcapiV1OrdersPaymentsMemberBalanceOrderMemberBalancePaymentUpdate: Represents the values required to update an order member balance payment
  - `value` number, double, nullable: Gets the monetary value, if applicable

## Response `200`

Success

- OcapiV1OrdersPaymentsMemberBalanceOrderMemberBalancePayment: Represents a member balance payment that has been added to an order base
  - `id` string, required: Gets the identifier that can be used to uniquely identify the payment within the order base
  - `type` 'CinemaProcessed' | 'Embedded' | 'GiftCard' | 'Redirect' | 'MemberBalance' | 'ExternallyProcessed' | 'PaymentCard', required: Represents the type of an order payment base
  - `value` number, double, required: Gets the monetary value
  - `status` 'NotStarted' | 'Pending' | 'Declined' | 'Completed', required: Represents the status of an order payment base
  - `balanceTypeId` integer, required: Gets the unique identifier of the balance type
  - `units` number, double, required: Gets the value in balance type units

## Other responses

- `400`: Member has no card, or a non-positive value was specified.
- `401`: No member signed in.

## Changes

- **2026-10-09** `41415d239083`: 1 warning
  - added the new `PaymentCard` enum value to the `type/allOf[subschema #1: OrderPaymentType]/` response property for the response status `200`

[Operation history](https://skmtc.dev/vista/apis/vista-digital-platform/changes/ocapi/v1/orders/:orderId/payments/member-balance/put.md)

---

[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)