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

# Add a settlement account

> Bank account in the organisation's name, one per currency. Verified by Ladder ops before payouts.



## OpenAPI

````yaml /openapi.json post /partner/v1/kyb/settlement-accounts
openapi: 3.0.3
info:
  title: Ladder Partner API
  version: v1
  description: >-
    Server-to-server API for licensed partner organisations: KYB, 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 what KYB still needs.
  - name: KYB
    description: >-
      Business information, people, documents, settlement accounts and
      submission.
  - name: Wallets
    description: >-
      Balances, funding requests on every rail, direct-debit mandates 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/kyb/settlement-accounts:
    parameters: []
    post:
      tags:
        - KYB
      summary: Add a settlement account
      description: >-
        Bank account in the organisation's name, one per currency. Verified by
        Ladder ops before payouts.
      operationId: kyb_settlement-accounts_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/PartnerSettlementAccount'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerSettlementAccountResponse'
        '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'
        '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'
        '429':
          description: Rate limited (120 requests/min per key). See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
components:
  schemas:
    PartnerSettlementAccount:
      required:
        - currency
        - bank_name
        - account_number
        - account_name
      type: object
      properties:
        id:
          title: Id
          type: string
          format: uuid
          readOnly: true
        currency:
          title: Currency
          type: string
          enum:
            - GHS
            - USD
            - NGN
        bank_name:
          title: Bank name
          type: string
          maxLength: 255
          minLength: 1
        bank_code:
          title: Bank code
          type: string
          maxLength: 50
        account_number:
          title: Account number
          type: string
          maxLength: 50
          minLength: 1
        account_name:
          title: Account name
          type: string
          maxLength: 255
          minLength: 1
        swift_code:
          title: Swift code
          type: string
          maxLength: 20
        is_verified:
          title: Is verified
          type: boolean
          readOnly: true
        created_at:
          title: Created_at
          type: string
          format: date-time
          readOnly: true
    PartnerSettlementAccountResponse:
      required:
        - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PartnerSettlementAccount'
    PartnerError:
      required:
        - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PartnerErrorBody'
    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.