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

# Simulate deposit

> Sandbox only. Pays a virtual account as if the customer had sent money, through the same fees, review rules, settlement and webhooks as a real payment. Refused in production with 403 simulation_unavailable. The account must be active.



## OpenAPI

````yaml /pagoramp-checkout-openapi.json post /api/v1/virtual-accounts/{uuid}/simulate-deposit
openapi: 3.0.0
info:
  title: Pagoramp Open API
  description: Our collection orchestration API for merchants to integrate to their system
  version: '1.0'
  contact: {}
servers:
  - url: https://pay-api.pagoramp.com
    description: Production
  - url: https://pay-api-staging.pagoramp.com
    description: Staging
security:
  - x-api-key: []
tags:
  - name: Checkout
    description: ''
  - name: P2P
    description: ''
  - name: Payment Links
    description: ''
  - name: Customer
    description: ''
  - name: Customers
    description: ''
  - name: Virtual Accounts
    description: ''
  - name: Misc
    description: ''
paths:
  /api/v1/virtual-accounts/{uuid}/simulate-deposit:
    post:
      tags:
        - Virtual Accounts
      summary: Simulate deposit
      description: >-
        Sandbox only. Pays a virtual account as if the customer had sent money,
        through the same fees, review rules, settlement and webhooks as a real
        payment. Refused in production with 403 simulation_unavailable. The
        account must be active.
      operationId: VirtualAccountsController_simulateDeposit
      parameters:
        - name: uuid
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulateDepositDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                example:
                  status: success
                  message: Deposit simulated successfully
                  data:
                    processed: true
                    transactionReference: va-17912345678901234
                    status: success
        '400':
          description: ''
          content:
            application/json:
              schema:
                example:
                  status: error
                  message: Say how much to pay
                  errors:
                    - field: amount
                      code: required
        '403':
          description: ''
          content:
            application/json:
              schema:
                example:
                  status: error
                  message: Deposits can be simulated in the sandbox only
                  errors:
                    - field: environment
                      code: simulation_unavailable
      security:
        - x-api-key: []
components:
  schemas:
    SimulateDepositDto:
      type: object
      properties:
        amount:
          type: number
          example: 5000
          description: >-
            Amount paid, in the account currency. Dynamic accounts default to
            their expected amount; dedicated accounts need one.
        senderName:
          type: string
          example: JOHN DOE
          description: >-
            Who paid. Defaults to the customer's name. A different name triggers
            the third-party sender review where it applies.
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````

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