> ## 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.

# Configuration

> Returns your organization's payout configuration: supported currencies, assets and transaction limits.

<Prompt description="Configuration" actions={["cursor"]}>
  Add the Zapyd "Configuration" call (`GET /pos/api/v1/payout/configuration`) to my backend. Returns your organization's payout configuration: supported currencies, assets and transaction limits.

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

  Success: HTTP 200, `{status: true, message, data}`.
  Errors (`{status: false, message, err_code, errors}`):

  * 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:

  * Keyed by lowercase fiat. Per fiat: supported assets and networks, crypto min and max per payment method, the valid `payment_method` values and `required_risk_parameters`.
  * Cache it and refresh daily. Validate the asset, network, payment method and amount against it before quoting.

  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 `getPayoutConfiguration` 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/payout/config/configuration.md`
</Prompt>

| API Status Code | Response | Reason |
| - | - | - |
| 500 | Internal Server Error. | Internal Server Error |


## OpenAPI

````yaml GET /payout/configuration
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:
  /payout/configuration:
    get:
      tags:
        - Payout
      description: >-
        Returns basic configuration for payout - supported fiats, supported
        assets and live coin limits
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Success
                  data:
                    type: object
                    description: One key per enabled fiat, in lowercase (for example inr).
                    additionalProperties:
                      type: object
                      properties:
                        supported_assets:
                          type: array
                          items:
                            type: string
                          description: Enabled assets, lowercase
                          example:
                            - usdt
                            - usdc
                        supported_networks:
                          type: object
                          description: Enabled networks per asset.
                          additionalProperties:
                            type: array
                            items:
                              type: string
                          example:
                            usdt:
                              - tron
                              - polygon
                            usdc:
                              - polygon
                        coin_limits:
                          type: object
                          description: >-
                            Crypto min and max per asset, network and payment
                            method: {asset: {network: {method: {min, max}}}}.
                          example:
                            usdt:
                              tron:
                                imps:
                                  min: 12
                                  max: 5000
                        required_risk_parameters:
                          type: array
                          items:
                            type: string
                          description: Keys you must send in risk_parameters on quotation
                          example:
                            - ip_address
                            - device_id
                        payment_methods:
                          type: object
                          description: >-
                            Settlement window per payment method and the
                            beneficiary amount bounds
                          additionalProperties:
                            type: object
                            properties:
                              min_settlement_time:
                                type:
                                  - integer
                                  - 'null'
                                description: Fastest settlement, in minutes
                                example: 1
                              max_settlement_time:
                                type:
                                  - integer
                                  - 'null'
                                description: Slowest settlement, in minutes
                                example: 30
                              min_receiving_amount:
                                type:
                                  - string
                                  - number
                                  - 'null'
                                description: >-
                                  Smallest fiat amount the beneficiary can
                                  receive
                                example: 100
                              max_receiving_amount:
                                type:
                                  - string
                                  - number
                                  - 'null'
                                description: >-
                                  Largest fiat amount the beneficiary can
                                  receive
                                example: 500000
        '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'
                  errors:
                    type: string
                    example: Unexpected error occurred. Please try again later.
      servers:
        - url: https://sandbox.zapyd.com/pos/api/v1
          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.