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

# Pay a bank-transfer checkout

> Sandbox only — responds 404 on production. Completes a bank-transfer checkout session by depositing into its pooled virtual account. `amount` defaults to the payment link's remaining balance; pass less to test underpayment or more for overpayment. Same `externalReference` replays with 200.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/simulations/checkout-deposit
openapi: 3.1.0
info:
  title: Chipper Platform API
  version: '2026-02-20'
  description: >-
    Payouts, collections, and FX across African rails — bank, mobile money, and
    stablecoins — through one API.
servers:
  - url: https://api.platform.chipper.ai
    description: Production (sk_live_ keys)
  - url: https://sandbox-api.platform.chipper.ai
    description: Sandbox (sk_test_ keys — simulated rails, no real money)
security:
  - bearerAuth: []
paths:
  /v1/simulations/checkout-deposit:
    post:
      tags:
        - Simulations
      summary: Pay a bank-transfer checkout
      description: >-
        Sandbox only — responds 404 on production. Completes a bank-transfer
        checkout session by depositing into its pooled virtual account. `amount`
        defaults to the payment link's remaining balance; pass less to test
        underpayment or more for overpayment. Same `externalReference` replays
        with 200.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                checkoutSessionId:
                  type: string
                  minLength: 1
                amount:
                  anyOf:
                    - type: string
                      pattern: ^\d+(\.\d{1,8})?$
                    - type: number
                      exclusiveMinimum: 0
                externalReference:
                  type: string
                  minLength: 1
                  maxLength: 255
              required:
                - checkoutSessionId
                - externalReference
      responses:
        '200':
          description: 'Idempotent replay — same body shape as 201 with `replayed: true`.'
        '201':
          description: The deposit was submitted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  simulation:
                    allOf:
                      - $ref: '#/components/schemas/VirtualAccountDepositSimulation'
                      - type: object
                        properties:
                          checkoutSessionId:
                            type: string
                            example: cs_test_x7kd92mfn3qp8wz4t6vb
                          paymentLinkId:
                            type: string
                            example: pl_test_h4n7q2vm8kp3r9zt5wbx
                        required:
                          - checkoutSessionId
                          - paymentLinkId
                required:
                  - simulation
        '400':
          description: Not a bank-transfer session, or the link has no remaining balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: bad_request
                message: Only bank-transfer checkout sessions accept simulated deposits
                requestId: req_q7vei435zifs51ia0lqr
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: unauthorized
                message: Invalid API key
                requestId: req_q7vei435zifs51ia0lqr
        '403':
          description: The API key lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: forbidden
                message: API key does not have the required scope
                requestId: req_q7vei435zifs51ia0lqr
        '404':
          description: 'Not available: production keys, or (deposits) no such resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: not_found
                message: Simulation endpoint not found
                requestId: req_q7vei435zifs51ia0lqr
        '409':
          description: This externalReference was already used with different parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: conflict
                message: >-
                  externalReference was already used for different balance
                  funding
                requestId: req_q7vei435zifs51ia0lqr
      security:
        - bearerAuth: []
components:
  schemas:
    VirtualAccountDepositSimulation:
      type: object
      properties:
        depositId:
          type: string
          example: vad_x7kd92mfn3qp8wz4t6vb
        collectionId:
          type: string
          description: >-
            The collection created for the inflow — poll it or wait for
            `collection.completed` / `collection.failed`.
          example: col_x7kd92mfn3qp8wz4t6vb
        virtualAccountId:
          type: string
          example: va_h4n7q2vm8kp3r9zt5wbx
        amount:
          type: string
          description: >-
            Amount as sent by the simulated bank, in the virtual account
            currency.
          example: '5000'
        currency:
          type: string
          example: NGN
        requestedOutcome:
          type: string
          enum:
            - completed
            - failed
        replayed:
          type: boolean
          description: >-
            True when this externalReference was already simulated and the
            original result is returned.
      required:
        - depositId
        - collectionId
        - virtualAccountId
        - amount
        - currency
        - requestedOutcome
        - replayed
    Error:
      type: object
      properties:
        error:
          type: string
          description: Stable machine-readable code.
        message:
          type: string
          description: Human-readable explanation.
        requestId:
          type: string
          description: Echoed in the x-request-id response header — quote it to support.
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `sk_test_…` (sandbox) or `sk_live_…` (production).'

````