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

# Simulate Deposit for On-Ramp (Sandbox)

> Simulates a fiat deposit for an on-ramp transaction in the sandbox environment. Valid for ARS, MXN, and COP currencies with bank_transfer paymentMethodType.

The field you need to send alongside `paymentMethodType` and `amount` depends on the customer's country. Use the value returned in `fiatPaymentInstructions` from the [Create On-Ramp Session](/ramps-api/on-ramp/create-on-ramp-session) or [Create On-Ramp Order](/ramps-api/on-ramp/create-on-ramp-order) response.


## OpenAPI

````yaml ramps-api/openapi.json POST /api/v1/simulateDeposit/
openapi: 3.1.0
info:
  title: Ripio Ramp API
  version: v1
  description: >-
    API for Ripio ramp services, enabling partners to integrate On-Ramp,
    Off-Ramp, customer management, KYC processes, and other financial
    functionalities. This API is RESTful, uses JSON for requests and responses,
    and standard HTTP status codes. This document is based on the
    'onramp-api.pdf' provided and aims to be compliant with OpenAPI
    Specification v3.1.0. The PDF indicates that the API documentation is a
    draft and subject to change.
servers:
  - url: https://skala-sandbox.ripio.com
    description: Sandbox environment
  - url: https://skala.ripio.com
    description: Production environment
security:
  - BearerToken: []
tags:
  - name: Authentication
    description: Operations related to API authentication and authorization.
  - name: Customers
    description: Operations related to customer management.
  - name: KYC
    description: Operations related to Know Your Customer processes.
  - name: Fiat Accounts
    description: Operations related to managing fiat accounts and their requirements.
  - name: Quotes
    description: Operations related to obtaining and managing conversion quotes.
  - name: On-Ramp
    description: Operations related to fiat-to-crypto (on-ramp) processes.
  - name: Off-Ramp
    description: Operations related to crypto-to-fiat (off-ramp) processes.
  - name: Transactions
    description: Operations related to listing and managing all transaction types.
  - name: Networks
    description: >-
      Operations related to retrieving available deposit and withdrawal
      networks.
  - name: Rates
    description: Operations related to retrieving market rates.
  - name: Sandbox
    description: Operations specific to the sandbox environment for testing purposes.
  - name: Webhooks
    description: Webhook event notifications from Ripio Ramp API.
  - name: Sell and Pay
    description: >-
      Endpoints for managing Sell and Pay transactions, which allow customers to
      convert cryptocurrency to fiat currency and pay merchants via QR codes
paths:
  /api/v1/simulateDeposit/:
    post:
      tags:
        - Sandbox
      summary: Simulate Deposit for On-Ramp (Sandbox)
      description: >-
        Simulates a fiat deposit for an on-ramp transaction in the sandbox
        environment. Valid for ARS, MXN, and COP currencies with bank_transfer
        paymentMethodType.
      operationId: simulateDeposit
      requestBody:
        required: true
        description: Details for simulating the deposit.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulateDepositRequest'
            examples:
              Argentina:
                summary: Argentina (ARS) - bank_transfer
                value:
                  paymentMethodType: bank_transfer
                  amount: 2100
                  alias_or_cvu: '1573308578877835214906'
              Mexico:
                summary: Mexico (MXN) - bank_transfer
                value:
                  paymentMethodType: bank_transfer
                  amount: 1500
                  clabe: '706180196550550550'
              Colombia:
                summary: Colombia (COP) - bank_transfer
                value:
                  paymentMethodType: bank_transfer
                  amount: 50000
                  payment_url: https://payment.cobre.co/abc123
      responses:
        '200':
          description: Deposit simulation successful. Returns 200 OK with empty body.
          content:
            application/json:
              schema:
                type: object
                properties: {}
                example: {}
        '400':
          description: >-
            Bad Request - e.g., invalid amount, invalid CVU/CLABE/payment URL,
            or endpoint not applicable for the currency/payment method.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - Invalid or missing access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 40001
                type: NotAuthenticated
                detail:
                  message: Authentication credentials were not provided.
                  code: not_authenticated
                status: 401
components:
  schemas:
    SimulateDepositRequest:
      type: object
      properties:
        paymentMethodType:
          type: string
          description: The payment method type for the simulated deposit.
          example: bank_transfer
        amount:
          type: number
          description: The amount of fiat to send.
          example: 2100
        alias_or_cvu:
          type: string
          description: >-
            Alias or CVU to which the deposit will be made (from onramp
            fiatPaymentInstructions). Used for ARS deposits.
          example: '0100000000000000000001'
        clabe:
          type: string
          description: >-
            CLABE to which the deposit will be made (from onramp
            fiatPaymentInstructions). Used for MXN deposits.
          example: '706180196550550550'
        payment_url:
          type: string
          format: uri
          description: >-
            Payment URL to identify the order (from onramp
            fiatPaymentInstructions). Used for COP deposits.
          example: https://example.com/payment/abc123
      required:
        - paymentMethodType
        - amount
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: Application-specific error code.
        type:
          type: string
          description: Type of error or exception.
        detail:
          type: object
          properties:
            message:
              type: string
              description: Detailed error message.
          additionalProperties: true
        status:
          type: integer
          description: HTTP status code.
      required:
        - code
        - type
        - detail
        - status
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token obtained via
        [/oauth2/token/](/ramps-api/authentication/acquire-access-token). Use as
        `Authorization: Bearer <access_token>`.

````