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

# Simulate a transfer (test only)



## OpenAPI

````yaml /openapi.yaml post /payment/checkout/charge/bank-transfer/simulate
openapi: 3.1.0
info:
  title: Vestrapay Payments API
  version: '1.0'
  description: >
    Initialize payments, collect card or bank transfer at checkout, and verify
    transactions. Amounts are major units as strings (100 naira is "100.00").
    Successful HTTP JSON is always `{ "status": "success", "data": … }`.
    Failures are `{ "status": "failed", "error", "message" }`. Webhook bodies
    are `{ "event", "data", "timestamp" }` and are not wrapped.
servers:
  - url: https://server.staging.vestrapay.app/v1
    description: Staging
  - url: https://api.vestrapay.com/v1
    description: Production
security:
  - SecretKey: []
tags:
  - name: Payments
    description: Server-to-server initialize and verify
  - name: Checkout
    description: Customer checkout session (access code)
paths:
  /payment/checkout/charge/bank-transfer/simulate:
    post:
      tags:
        - Checkout
      summary: Simulate a transfer (test only)
      operationId: simulate-bank-transfer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - scenario
              properties:
                scenario:
                  type: string
                  enum:
                    - success
                    - failed
                    - abandoned
      responses:
        '201':
          description: Simulation accepted
        '403':
          description: Not test mode
      security:
        - AccessCode: []
components:
  securitySchemes:
    SecretKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Secret key (sk_test_ or sk_live_). Authorization Bearer with the same
        value is also accepted.
    AccessCode:
      type: apiKey
      in: header
      name: x-access-code
      description: Access code from initialize. Query access_code is also accepted.

````