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

# Simulate a bank pay-in

> Forwards a simulated pay-in onto the caller's OWN test account. Only exists on a deployment whose bank provider is a sandbox; on production the path answers 404 not_found. Only the EUR/IBAN rail is wired.

<Note>**Provider sandbox on this deployment.** Our backend targets the bank provider's sandbox: bank details are test details, no real transfer settles, and settlement lands on a testnet (read `network` from GET /v1/config). Known limits: only the EUR/IBAN rail is wired for the simulated pay-in, and identity checks run on test-mode applicants. Every response says which environment answered in its `environment` field.</Note>


## OpenAPI

````yaml https://backend.rheon.io/openapi.json post /v1/virtual-accounts/{id}/test-deposit
openapi: 3.1.0
info:
  title: Rheon partner API
  version: 1.0.0
  description: >-
    The /v1 surface a partner's backend calls with an API key.


    **Authentication.** Every route takes `Authorization: Bearer <key>`. One
    kind of key: it carries its permissions and limits, and works from your
    server, a page, or this playground alike - where it is called from is not
    checked. Treat it as a secret all the same: anyone holding it acts under its
    permissions until it is rotated.


    **Rate limit.** Counted per key, at the requests-per-second rate configured
    on the key - never per IP, so your users do not throttle each other. Over
    it: `429 rate_limited`.


    **Amounts.** Token amounts are decimal strings in the token's smallest unit;
    fiat amounts are decimal strings in major units. Never JSON numbers.


    **Errors.** One envelope everywhere: `{ error: { code, message } }`, with
    `fields` added on bank refusals that named a field. A body that is not valid
    JSON answers `400 invalid_request`; an endpoint that does not exist answers
    `404 not_found`; a deployment with no partner keys configured answers `404
    not_configured` for all of /v1.


    **Environment.** Every response carries `environment` as its first field:
    `sandbox` or `production`, derived from the upstreams this deployment is
    configured against (never a flag). Read it off any response you paste into a
    ticket. In `sandbox` no real money moves and the card corridor is the
    provider's sandbox asset, which differs from production - read it from GET
    /v1/config, not from these docs.


    **Card corridor.** The asset and chain a card purchase settles as are fixed
    per deployment, not chosen per request. GET /v1/config reports the one
    actually configured.
servers:
  - url: https://api.rheon.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Configuration
  - name: Crypto deposits
  - name: Orders
  - name: Cards
  - name: Bank transfers
  - name: Virtual accounts
  - name: Reference
  - name: Sandbox only
paths:
  /v1/virtual-accounts/{id}/test-deposit:
    post:
      tags:
        - Sandbox only
      summary: Simulate a bank pay-in
      description: >-
        Forwards a simulated pay-in onto the caller's OWN test account. Only
        exists on a deployment whose bank provider is a sandbox; on production
        the path answers 404 not_found. Only the EUR/IBAN rail is wired.
      operationId: testDeposit
      parameters:
        - in: path
          name: id
          schema:
            type: string
            description: The virtual account id.
            example: va_1
          required: true
          description: The virtual account id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestDepositRequest'
      responses:
        '200':
          description: The provider's simulation answer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxResult'
        '400':
          description: >-
            Cannot simulate this.


            - `invalid_request`: amount not a decimal string, or the account
            carries no IBAN.

            - `<provider code>`: The bank provider refused (4xx); its code is
            passed through.
          x-error-codes:
            - invalid_request
            - <provider code>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: >-
            No usable API key.


            - `unauthorized`: Missing, malformed or unknown key. One
            undifferentiated answer on purpose.
          x-error-codes:
            - unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: >-
            Refused by permission.


            - `permission_denied`: The key does not carry the `virtual-accounts`
            permission.
          x-error-codes:
            - permission_denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: >-
            Not here.


            - `not_found`: Foreign or unknown account - or a production
            deployment, where this route does not exist.
          x-error-codes:
            - not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: >-
            Over this key's rate.


            - `rate_limited`: More requests per second than the key is
            configured for. Counted PER KEY (all your users share one bucket),
            never per IP.
          x-error-codes:
            - rate_limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '500':
          description: >-
            Our fault.


            - `internal`: Unexpected server error. Detail is in our logs, never
            on the wire.
          x-error-codes:
            - internal
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '502':
          description: >-
            The provider behind this route is unavailable.


            - `upstream_error`: The payment provider answered a 5xx or did not
            answer.
          x-error-codes:
            - upstream_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - bearerAuth: []
components:
  schemas:
    TestDepositRequest:
      type: object
      properties:
        amount:
          type: string
          pattern: ^\d+(\.\d+)?$
          description: >-
            The pay-in amount, verbatim, in the account's currency (major
            units).
          example: '100'
        accountHolderName:
          description: >-
            Depositor name on the simulated statement. Empty or absent means
            "Rheon test depositor".
          type: string
        reference:
          description: >-
            Reference line on the simulated statement. Empty or absent means
            "rheon test deposit".
          type: string
      required:
        - amount
    SandboxResult:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/Environment'
        testEnvironment:
          type: boolean
          const: true
          description: 'Always true: nothing recorded off these endpoints is a real event.'
        result:
          description: The provider's own simulation answer, verbatim.
      required:
        - environment
        - testEnvironment
        - result
      additionalProperties: false
    ErrorEnvelope:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/Environment'
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine-readable error code. Branch on this, never on the
                message.
              example: invalid_request
            message:
              type: string
              description: Human-readable explanation. Wording may change.
              example: amount must be a decimal string of the token's smallest unit.
            fields:
              description: >-
                Per-field complaints from the bank provider, when it named the
                field it refused (bank routes only). Field names, never values.
              example:
                applicantInfo.nationality: iso3166_1_alpha2
              type: object
              propertyNames:
                type: string
              additionalProperties:
                type: string
          required:
            - code
            - message
          additionalProperties: false
      required:
        - environment
        - error
      additionalProperties: false
      description: The one error shape this API produces.
    Environment:
      type: string
      enum:
        - sandbox
        - production
      description: >-
        Which environment answered. `sandbox`: at least one money upstream is
        the provider's sandbox - no real money moves there, and the card
        corridor is the sandbox's asset (read GET /v1/config), not the
        documented production one. `production`: every configured upstream is
        real. Derived from the configured upstream hosts at boot, never a flag.
      example: sandbox
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, issued by us and shown once at creation.

````