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

# Withdraw to a settlement account

> Sends money from your wallet to one of your **verified** settlement accounts in the same currency. The wallet is debited immediately (402 `insufficient_funds` if short), so the amount cannot also be spent on an order while the withdrawal waits. Ladder approves every withdrawal and pays it to the account by bank transfer: `pending_approval` → `approved` → `completed` (with `payout_reference`, the bank reference). A `rejected` or `failed` withdrawal is credited back to the wallet. Webhooks: `withdrawal.created`, `withdrawal.completed`, `withdrawal.rejected`, `withdrawal.failed`. Test keys complete immediately with `payout_reference` `SANDBOX`.



## OpenAPI

````yaml /openapi.json post /partner/v1/withdrawals
openapi: 3.0.3
info:
  title: Ladder Partner API
  version: v1
  description: >-
    Server-to-server API for licensed partner organisations: NGN/GHS/USD
    wallets, funding rails, investments and NGX market data, buy and sell
    orders, holdings and webhooks. Every request is HMAC-signed; see the
    Authentication guide.
  contact:
    email: partners@myladder.africa
servers:
  - url: https://api.myladder.africa
    description: Production
  - url: https://api-dev.myladder.africa
    description: UAT (integration and acceptance testing)
security:
  - LadderKey: []
    LadderTimestamp: []
    LadderSignature: []
tags:
  - name: Organisation
    description: The calling organisation and where Ladder's review of it stands.
  - name: Wallets
    description: >-
      Balances, funding requests on every rail, direct-debit mandates,
      settlement accounts and the ledger statement.
  - name: Investments
    description: What a partner can buy.
  - name: Market data
    description: >-
      Nigerian Exchange instruments, quotes, bars, indices, FX, calendar and
      disclosures.
  - name: Orders
    description: Buy and sell orders and their lifecycle.
  - name: Holdings
    description: Positions created by completed buys.
  - name: Webhooks
    description: Endpoints, deliveries and retries.
  - name: Sandbox
    description: Test-key only helpers.
paths:
  /partner/v1/withdrawals:
    parameters: []
    post:
      tags:
        - Wallets
      summary: Withdraw to a settlement account
      description: >-
        Sends money from your wallet to one of your **verified** settlement
        accounts in the same currency. The wallet is debited immediately (402
        `insufficient_funds` if short), so the amount cannot also be spent on an
        order while the withdrawal waits. Ladder approves every withdrawal and
        pays it to the account by bank transfer: `pending_approval` → `approved`
        → `completed` (with `payout_reference`, the bank reference). A
        `rejected` or `failed` withdrawal is credited back to the wallet.
        Webhooks: `withdrawal.created`, `withdrawal.completed`,
        `withdrawal.rejected`, `withdrawal.failed`. Test keys complete
        immediately with `payout_reference` `SANDBOX`.
      operationId: withdrawals_create
      parameters:
        - name: Idempotency-Key
          in: header
          description: >-
            Unique per logical request (max 255 chars). A retry with the same
            key and body returns the original response with
            `Idempotent-Replayed: true`; a different body returns 409.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerCreateWithdrawal'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerWithdrawalResponse'
        '400':
          description: Validation or business-rule error (see `error.code`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
        '401':
          description: Missing/invalid signature, stale timestamp, unknown or revoked key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
        '402':
          description: Insufficient wallet balance (`insufficient_funds`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
        '403':
          description: IP not allowlisted, or action not allowed for this key/environment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
        '404':
          description: Not found (or belongs to another organisation/environment).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
        '409':
          description: >-
            Conflict: state does not allow this action, duplicate reference, or
            Idempotency-Key reuse.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
        '429':
          description: Rate limited (120 requests/min per key). See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
components:
  schemas:
    PartnerCreateWithdrawal:
      required:
        - currency
        - amount
        - settlement_account_id
      type: object
      properties:
        currency:
          title: Currency
          type: string
          enum:
            - GHS
            - USD
            - NGN
        amount:
          title: Amount
          type: string
          format: decimal
        settlement_account_id:
          title: Settlement account id
          description: >-
            A verified settlement account of yours in the same currency (GET
            /kyb/settlement-accounts).
          type: string
          format: uuid
    PartnerWithdrawalResponse:
      required:
        - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PartnerWithdrawal'
    PartnerError:
      required:
        - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PartnerErrorBody'
    PartnerWithdrawal:
      type: object
      properties:
        id:
          title: Id
          type: string
          format: uuid
          readOnly: true
        reference:
          title: Reference
          type: string
          readOnly: true
          minLength: 1
        status:
          title: Status
          type: string
          enum:
            - pending_approval
            - approved
            - completed
            - rejected
            - failed
          readOnly: true
        currency:
          title: Currency
          type: string
          enum:
            - GHS
            - USD
            - NGN
          readOnly: true
        amount:
          title: Amount
          type: string
          format: decimal
          readOnly: true
        fee:
          title: Fee
          type: string
          format: decimal
          readOnly: true
        settlement_account_id:
          title: Settlement account id
          type: string
          format: uuid
          readOnly: true
        payout_reference:
          title: Payout reference
          type: string
          readOnly: true
          minLength: 1
        failure_reason:
          title: Failure reason
          type: string
          readOnly: true
          minLength: 1
        approved_at:
          title: Approved at
          type: string
          format: date-time
          readOnly: true
          nullable: true
        resolved_at:
          title: Resolved at
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          title: Created_at
          type: string
          format: date-time
          readOnly: true
    PartnerErrorBody:
      required:
        - code
        - message
        - details
      type: object
      properties:
        code:
          title: Code
          description: Stable machine-readable code, e.g. `insufficient_funds`.
          type: string
          minLength: 1
        message:
          title: Message
          type: string
          minLength: 1
        details:
          title: Details
          description: Code-specific context (validation errors, balances, …).
          type: object
          additionalProperties:
            type: string
            nullable: true
  securitySchemes:
    LadderKey:
      type: apiKey
      in: header
      name: X-Ladder-Key
      description: 'Your key id: `pk_test_…` (sandbox) or `pk_live_…` (live).'
    LadderTimestamp:
      type: apiKey
      in: header
      name: X-Ladder-Timestamp
      description: Unix seconds, as a string; must be within 5 minutes of server time.
    LadderSignature:
      type: apiKey
      in: header
      name: X-Ladder-Signature
      description: >-
        Lower-case hex HMAC-SHA512 over timestamp, method, path+query and the
        SHA-256 of the body. See Authentication.

````

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