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

# Request Settlement

Submit a settlement request for processing.


## OpenAPI

````yaml POST /api/v3/integrator/settlements
openapi: 3.0.0
info:
  title: KOTANI PAY API PLATFORM
  description: ''
  version: '3.0'
  contact: {}
servers:
  - url: https://sandbox-api.kotanipay.io
    description: Sandbox
security: []
tags: []
paths:
  /api/v3/integrator/settlements:
    post:
      tags:
        - INTEGRATOR
      operationId: IntegratorSettlementsController_createRequest_api/v3
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSettlementRequestDto'
      responses:
        '201':
          description: ''
      security:
        - JWT: []
components:
  schemas:
    CreateSettlementRequestDto:
      type: object
      properties:
        walletId:
          type: string
        amount:
          type: number
        balanceSource:
          type: string
          enum:
            - PAYOUT
            - DEPOSIT
            - ADMIN_SELECT
        integratorNote:
          type: string
        callbackUrl:
          type: string
        beneficiaryDetails:
          $ref: '#/components/schemas/BeneficiaryDetailsDto'
        savedBeneficiaryId:
          type: string
          description: >-
            ID of a saved beneficiary on the integrator config — used when
            beneficiaryDetails is not explicitly provided
        overrideUsdRate:
          type: number
          description: >-
            Admin-supplied exchange rate as "1 USD = X local currency".
            Overrides the auto-fetched rate for USD snapshot computation. Only
            meaningful for non-USD wallets.
          example: 129.5
      required:
        - walletId
        - amount
    BeneficiaryDetailsDto:
      type: object
      properties:
        beneficiaryType:
          type: string
          enum:
            - bank
            - crypto
        name:
          type: string
        walletAddress:
          type: string
        chain:
          type: string
        token:
          type: string
          description: Token/asset symbol (e.g. USDT, USDC)
        network:
          type: string
          description: Network sub-type (legacy)
        bankName:
          type: string
        bankCode:
          type: string
        accountNumber:
          type: string
        accountName:
          type: string
        accountType:
          type: string
  securitySchemes:
    JWT:
      scheme: bearer
      bearerFormat: JWT
      type: http

````