> ## Documentation Index
> Fetch the complete documentation index at: https://help-loyalife.xoxoday.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check Availability

> Verify a member's redeemable points balance before initiating a redemption.

Queries a member's current redeemable points balance in real time. Always call this before [Redeem Points](/api-reference/payment-gateway/redeem-points) to confirm the member has sufficient balance.

**Partial redemption is not supported** — members must redeem points covering the full transaction value. The points-to-currency conversion rate is configurable per program; confirm the rate for your program with your Xoxoday implementation contact to correctly calculate how many points equal the cart value.

## Responses

<AccordionGroup>
  <Accordion title="200 — Success">
    | Path                       | Type    | Description                                        |
    | -------------------------- | ------- | -------------------------------------------------- |
    | `results.IsSucessful`      | boolean | `true`                                             |
    | `results.ErrorCode`        | string  | `000`                                              |
    | `results.ExceptionMessage` | string  | `Success`                                          |
    | `results.ReturnObject`     | integer | **The member's current redeemable points balance** |
  </Accordion>
</AccordionGroup>

***

## Error Codes

| Code  | ExceptionMessage            | Cause                                          |
| ----- | --------------------------- | ---------------------------------------------- |
| `000` | Success                     | Current balance returned                       |
| `103` | Member does not exist       | `RelationReference` not found in the program   |
| `107` | Member status is not Active | Member has not been activated                  |
| `999` | Bad request                 | Missing required fields in the request payload |


## OpenAPI

````yaml POST /lbms-ingress/pg-lm/API/PG/CheckAvailability
openapi: 3.1.0
info:
  title: Loyalife LBMS API
  description: >-
    REST API for Loyalife's Loyalty Management System. Covers member management,
    OTP authentication, loyalty transactions, and points redemption.
  version: 1.0.0
  contact:
    name: Xoxoday Support
    email: support@xoxoday.com
servers:
  - url: https://loyalife-api.xoxoday.in
    description: Production
security:
  - bearerAuth: []
paths:
  /lbms-ingress/pg-lm/API/PG/CheckAvailability:
    post:
      tags:
        - Points Redemption
      summary: Check Availability
      description: >-
        Verify a member's redeemable points balance before initiating a
        redemption.
      operationId: checkAvailability
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - RelationReference
                - TransactionCurrency
                - RelationType
                - ProgramId
              properties:
                RelationReference:
                  type: string
                  example: jane.doe@example.com
                TransactionCurrency:
                  type: string
                  example: DEFAULT
                RelationType:
                  type: integer
                  description: Use `4` for customers
                  example: 4
                ProgramId:
                  type: integer
                  example: 19
            example:
              RelationReference: jane.doe@example.com
              TransactionCurrency: DEFAULT
              RelationType: 4
              ProgramId: 19
      responses:
        '200':
          description: Balance retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: object
                    properties:
                      IsSucessful:
                        type: boolean
                      ErrorCode:
                        type: string
                      ExceptionMessage:
                        type: string
                      ReturnObject:
                        type: integer
                        description: Member's current redeemable points balance
                        example: 910
              example:
                results:
                  IsSucessful: true
                  ErrorCode: '000'
                  ExceptionMessage: Success
                  ReturnObject: 910
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT obtained from Generate Auth Token. Pass as `Authorization: bearer
        {token}`.

````