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

# Fetch Balance

> Returns the prefunded wallet's available balance for each asset. The value is cached briefly.

<Prompt description="Fetch Balance" actions={["cursor"]}>
  Add the Zapyd "Fetch Balance" call (`GET /pos/api/v1/payout/balance`) to my backend. Returns the prefunded wallet's available balance for each asset. The value is cached briefly.

  * Sandbox: `GET https://sandbox.zapyd.com/pos/api/v1/payout/balance`
  * Production: `GET https://api.zapyd.com/pos/api/v1/payout/balance`

  Success: HTTP 200, `{status: true, message, data}`. `data`: `available_balance` (Map of asset code to available balance (as a decimal string)).
  Errors (`{status: false, message, err_code, errors}`):

  * 400 `Bad Request`: Prefunding flow is not enabled for your organization (`err_code: PREFUNDED_NOT_ENABLED`)
  * 500 `Internal Server Error`
    Every endpoint can also return 401 `AUTH_*` (signature, timestamp or key: fix, don't retry), and 429 or 5xx (retry with backoff).

  Rules:

  * Your prefunded wallet's balance per asset, in `available_balance`. Used by prefunded payouts and prefunded India remittances.
  * Compare it with the quotation's `sending_amount` before you initiate, and top up first if it's too low. The value is cached briefly, so a top-up can take a moment to show.

  Signing (every request):

  * Headers: `X-API-KEY`, `X-TIMESTAMP` (Unix seconds, within 300 s of server time; generate per request) and `X-SIGNATURE`.
  * `X-SIGNATURE` = Base64(HMAC-SHA256(key = API secret, message = apiKey + "|" + timestamp + "|" + canonicalBody)). Base64 of the raw digest, not hex.
  * canonicalBody: the JSON body with keys sorted at every nesting level, no whitespace (separators `,` and `:`), and every non-ASCII character escaped as lowercase `\uXXXX` (Python `json.dumps(body, sort_keys=True, separators=(",", ":"))`). Requests with no body (GET, DELETE) sign `{}`. Query parameters are not signed.
  * Send the exact canonicalBody string you signed as the request body, with `Content-Type: application/json`.
  * Test vector: key `3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d`, secret `test-secret-do-not-use`, timestamp `1735689600`. Signing `{}` gives `6sCtVSRQjU9+2/af8gdwUAvY1l6Ii6ENcbRfanPkhY0=`. Body `{"customer_id":"78c99d71-f28f-47a9-8302-93b286efbe0e","amount":100.5,"currency":"INR","meta":{"note":"Café","b":2,"a":1}}` gives `l+DvQrzlKbsOSxSYOdWoWHEehcFRZfDJPKlLDkm2cSI=`.

  Deliver:

  1. A typed `fetchPayoutBalance` function in this codebase's language and HTTP client. Reuse an existing Zapyd client and signer, or write one small shared client.
  2. Config from `ZAPYD_API_KEY`, `ZAPYD_API_SECRET` and `ZAPYD_BASE_URL`. The secret stays on the server, never in a browser or app.
  3. Return `data`. When `status` is false, throw an error with the HTTP status, `err_code`, `message` and `errors`. Don't show raw errors to end users.
  4. Retry only 429 and 5xx: exponential backoff from 1 s, capped at 30 s, at most 5 attempts.
  5. Amounts as strings. Types for every field above.
  6. Tests: the signer against the test vector, and this call against sandbox.

  Reference: `https://docs.zapyd.com/api-reference-exchange/endpoint/remittance-payout/balance.md`
</Prompt>

## Error Codes and Messages

| API Status Code | Response | Reason |
| - | - | - |
| 400 | Bad Request | Prefunding flow is not enabled for your organization (`err_code: PREFUNDED_NOT_ENABLED`) |
| 500 | Internal Server Error | Internal Server Error |


## OpenAPI

````yaml GET /pos/api/v1/payout/balance
openapi: 3.1.0
info:
  title: Zapyd API
  description: API for Zapyd - Customer, Payout, and Webhook services
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://sandbox.zapyd.com/pos/api/v1
    description: Payout API Base URL
    variables:
      base_url:
        default: https://sandbox.zapyd.com
  - url: https://sandbox.zapyd.com/cms/api/v1
    description: Customer API Base URL
    variables:
      base_url:
        default: https://sandbox.zapyd.com
security:
  - ApiKeyAuth: []
    TimestampAuth: []
    SignatureAuth: []
tags:
  - name: Customer
    description: Customer related operations
    x-displayName: Customer
    x-traitTag: true
  - name: Payout
    description: Payout related operations
  - name: Webhooks
    description: Webhook related operations
  - name: Widget
    description: Hosted buy/sell widget session initialization
paths:
  /pos/api/v1/payout/balance:
    get:
      tags:
        - Payout
      description: >-
        Returns the available balance per asset for your organization's
        prefunded wallet. The response is cached briefly, so a just-completed
        top-up or payout may take a short while to reflect.
      responses:
        '200':
          description: Prefunded wallet balance fetched successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Success
                  data:
                    type: object
                    properties:
                      available_balance:
                        type: object
                        description: >-
                          Map of asset code to available balance (as a decimal
                          string)
                        additionalProperties:
                          type: string
                        example:
                          USDT: '15000.5'
        '400':
          description: Bad Request — prefunding flow is not enabled for the organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Bad Request
                  data:
                    type: 'null'
                  errors:
                    type: object
                    properties:
                      payout:
                        type: array
                        items:
                          type: string
                        example:
                          - >-
                            This endpoint is not available for your
                            organization.
                  err_code:
                    type: string
                    example: PREFUNDED_NOT_ENABLED
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Internal Server Error
                  data:
                    type: 'null'
                  err_code:
                    type: string
                    example: SYS_INTERNAL_ERROR
                  errors:
                    type: string
                    example: Unexpected error occurred. Please try again later.
      servers:
        - url: https://sandbox.zapyd.com
          description: Payout API Base URL
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API Key for authentication
    TimestampAuth:
      type: apiKey
      in: header
      name: X-TIMESTAMP
      description: Current timestamp in seconds since epoch
    SignatureAuth:
      type: apiKey
      in: header
      name: X-SIGNATURE
      description: HMAC SHA256 signature of the request encoded in Base64

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.