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

# Payout Limits

> Returns the EDD transaction limits applicable to a specific customer for payout.

<Prompt description="Payout Limits" actions={["cursor"]}>
  Integrate the DollarPe Payout Limits endpoint into my application.

  Endpoint: GET /ren/api/v1/payout/limits/{customer_id}
  Base URL: [https://api.dollarpe.in](https://api.dollarpe.in) (production) | [https://sandbox.dollarpe.in](https://sandbox.dollarpe.in) (sandbox)

  Auth headers required on every request:

  * X-API-KEY: your API key
  * X-TIMESTAMP: current Unix time in seconds
  * X-SIGNATURE: Base64(HMAC-SHA256(X-API-KEY + X-TIMESTAMP + sortedJSONBody, apiSecret))

  Task: Write a typed function that:

  1. Accepts a customer\_id string
  2. Builds the auth headers
  3. Calls GET /ren/api/v1/payout/limits/{customer_id}
  4. Returns the customer's payout limits (available limit, total limit, used amount)
  5. Handles 400 (customer not found) and 500 errors

  Language: TypeScript
</Prompt>

| API Status Code | Response                            | Reason                                       |
| --------------- | ----------------------------------- | -------------------------------------------- |
| 400             | Customer not found or access denied | Customer not found                           |
| 400             | Customer not found or access denied | Customer does not belong to the organization |
| 500             | Internal Server Error.              | Internal Server Error                        |


## OpenAPI

````yaml GET /ren/api/v1/payout/limits/{customer_id}
openapi: 3.1.0
info:
  title: DollarPe API
  description: API for DollarPe - Customer, Payout, and Webhook services
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://sandbox.dollarpe.xyz/pos/api/v1
    description: Payout API Base URL
    variables:
      base_url:
        default: https://sandbox.dollarpe.xyz
  - url: https://sandbox.dollarpe.xyz/cms/api/v1
    description: Customer API Base URL
    variables:
      base_url:
        default: https://sandbox.dollarpe.xyz
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:
  /ren/api/v1/payout/limits/{customer_id}:
    get:
      tags:
        - Payout
      description: Payout limits for the customer
      parameters:
        - name: customer_id
          in: path
          required: true
          description: Customer's unique identifier
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Payout limits for customer fetched successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Success
                  data:
                    type: object
                    properties:
                      daily_limit:
                        type: number
                        description: Daily payout limit of the user (In FIAT)
                        example: 500000
                      available_limit:
                        type: number
                        description: Currently available payout limit of the user (In FIAT)
                        example: 100000
                      payment_method_limits:
                        type: object
                        properties:
                          per_transaction_limit:
                            type: object
                            example:
                              UPI: 100000
                              IMPS: 100000
                          total_available_limit:
                            type: object
                            example:
                              UPI: 100000
                              IMPS: 100000
                      full_limit_reset_timestamp:
                        type: string
                        description: Timestamp at which full daily limit is available next
                        example: '2024-03-13T10:00:00Z'
                      is_edd_required:
                        type: boolean
                        description: >-
                          Is EDD required for the customer before further
                          payouts are processed?
                        example: false
                      is_limit_increase_available:
                        type: boolean
                        description: Can user perform EDD to increase their limits?
                        example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Bad Request
                  err_code:
                    type: string
                    example: REQ_FIELD_MISSING
                  errors:
                    type: object
                    properties:
                      customer_id:
                        type: array
                        items:
                          type: string
                        customer_id:
                          - This field is required
                  data:
                    type: 'null'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Internal Server Error
                  err_code:
                    type: string
                    example: SYS_INTERNAL_ERROR
                  errors:
                    type: string
                    example: Unexpected error occurred. Please try again later.
                  data:
                    type: 'null'
      servers:
        - url: https://sandbox.dollarpe.xyz
          description: Payout EDD 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

````