> ## Documentation Index > Fetch the complete documentation index at: https://docs.hifi.com/llms.txt > Use this file to discover all available pages before exploring further. # Simulate an onramp deposit > Simulate an inbound fiat deposit against an onramp. Available in the sandbox environment only; unsupported for onramps not routed through a rail that supports simulation. ## OpenAPI ````yaml https://production.hifi.com/api/v3/openapi.json post /v3/onramps/{onrampId}/simulate-deposits openapi: 3.0.0 info: title: Hifi API version: 3.0.0 description: API documentation for HIFI servers: - url: https://production.hifi.com description: Production server - url: https://sandbox.hifi.com description: Sandbox server security: - bearerAuth: [] tags: - name: Common description: Common endpoints - name: User description: User endpoints - name: Counter Party description: Counter party endpoints - name: Crypto Transfer description: Crypto transfer and batch transfer endpoints - name: Wallet description: Wallet and wallet offer endpoints - name: External Account description: External bank account endpoints (under a counter party) - name: External Wallet description: External wallet endpoints (under a counter party) - name: External Card description: External card endpoints (under a counter party) - name: Token Swap description: Token swap endpoints - name: Bridge description: Bridge endpoints - name: Virtual Account description: Virtual account endpoints - name: Compliance description: Compliance and compliance link endpoints - name: Webhook Endpoint description: Webhook endpoint endpoints - name: File description: File upload endpoints - name: Onramp description: Onramp (fiat to crypto) endpoints - name: Offramp description: Offramp (crypto to fiat) endpoints - name: Orchestration Address description: Orchestration (liquidation) address endpoints - name: KYC Link description: Hosted and custom KYC/KYB link endpoints - name: Transfer Approval description: Transfer approval endpoints - name: Corridor description: Supported fiat/crypto transfer corridor endpoints - name: Migration description: v2-to-v3 ID mapping endpoints paths: /v3/onramps/{onrampId}/simulate-deposits: post: tags: - Onramp summary: Simulate an onramp deposit description: > Simulate an inbound fiat deposit against an onramp. Available in the sandbox environment only; unsupported for onramps not routed through a rail that supports simulation. operationId: v3SimulateOnrampDeposit parameters: - $ref: '#/components/parameters/OnrampIdPathParameter' requestBody: $ref: '#/components/requestBodies/SimulateOnrampDepositBody' responses: '200': $ref: '#/components/responses/SimulateOnrampDepositResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' components: parameters: OnrampIdPathParameter: name: onrampId in: path required: true schema: type: string description: Public ID of the onramp transaction (prefixed with `onramp_`) example: onramp_7bV1aLcs3Kf9dQ2mNpXwZ requestBodies: SimulateOnrampDepositBody: required: true description: Simulate an inbound fiat deposit for an onramp. Sandbox only. content: application/json: schema: $ref: '#/components/schemas/OnrampSimulateDepositBody' examples: ACHDeposit: summary: Simulate an ACH deposit value: amount: 100 transferType: ACH reference: REF-12345 source: routingNumber: '021000021' accountNumber: '123456789' name: John Doe bankName: Chase Bank responses: SimulateOnrampDepositResponse: description: Simulated deposit submitted successfully. content: application/json: schema: $ref: '#/components/schemas/OnrampSimulateDepositResponseObject' example: message: Simulated deposit submitted successfully. BadRequestResponse: description: Bad Request — the request was malformed or failed validation. content: application/json: schema: $ref: '#/components/schemas/ApiError' example: type: VALIDATION_ERROR message: One or more fields are invalid or missing. fields: - code: invalid_value message: Must be a valid email address field: email UnauthorizedResponse: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized' NotFoundResponse: description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFound' InternalServerErrorResponse: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' schemas: OnrampSimulateDepositBody: type: object description: >- Simulate an inbound fiat deposit against an onramp in the sandbox environment. required: - amount - transferType - source properties: amount: type: number minimum: 0.01 maximum: 100000000 example: 100 transferType: type: string enum: - ACH - WIRE example: ACH reference: type: string maxLength: 35 description: Optional reference code for the simulated deposit. example: REF-12345 source: $ref: '#/components/schemas/OnrampSimulateDepositSource' OnrampSimulateDepositResponseObject: type: object description: Result of a simulated sandbox deposit. properties: message: type: string example: Simulated deposit submitted successfully. ApiError: type: object description: >- Standard v3 error shape, returned by validation failures and business-logic errors alike. properties: type: type: string description: >- Machine-readable error type, e.g. VALIDATION_ERROR, ACTION_NOT_ALLOWED, RESOURCE_CONFLICT. example: VALIDATION_ERROR message: type: string description: Human-readable error message. example: One or more fields are invalid or missing. fields: type: array description: >- Present on field-level validation errors. One entry per problem field. items: type: object properties: code: type: string description: Error code related to the field issue. message: type: string description: Error message for the specific issue. field: type: string description: The name of the field that has an issue. Unauthorized: type: object properties: type: type: string description: Unauthorized enum example: UNAUTHORIZED message: type: string description: Unauthorized message example: Authentication required NotFound: type: object properties: type: type: string example: RESOURCE_NOT_FOUND description: The error type, e.g., RESOURCE_NOT_FOUND message: type: string description: A descriptive error message fields: type: array description: List of specific field errors items: type: object properties: code: type: string description: Error code related to the field issue message: type: string description: Error message for the specific issue field: type: string description: The name of the field that has an issue InternalServerError: type: object properties: type: type: string example: INTERNAL_SERVER_ERROR description: Internal server error enum message: type: string example: An internal server error occurred description: Internal server error message OnrampSimulateDepositSource: type: object description: Simulated originating bank account for the sandbox deposit. required: - routingNumber - accountNumber - name - bankName properties: routingNumber: type: string minLength: 1 maxLength: 10 example: '021000021' accountNumber: type: string minLength: 1 maxLength: 17 example: '123456789' name: type: string minLength: 1 maxLength: 35 description: Name of the account holder. example: John Doe bankName: type: string minLength: 1 maxLength: 35 example: Chase Bank securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````