Simulating Address Deposits in Sandbox Environment

For testing purposes in the sandbox environment, actual money transfers are not allowed. Instead, a dedicated method is provided to simulate fund transfers to the given address.

Request

To simulate deposits, a POST request is made to this endpoint api/v1/payouts/simulate-address-deposit with the address and the specified amounts. Here's a sample request payload:

Sample Request Payload

{
    "address": "TS8bXUyq2QdyYceKVxcvJpHQ6NX6qY2xaZ",
    "amount": 200
}

Field	Type	Description
`address`	String	The provided address in the finalized quote.
`amount`	Number	The exact amount to simulate (e.g., USD, BTC, etc.), as gotten from the `amount` field in the finalized quote

Response

The response, tells you whether the attempt at simulation was successful or not. Here's what it looks like:

{
    "status": true,
    "message": "OffRamp simulate address deposit successfully",
    "data": {
        "success": true
    }
}

Note: The simulate-address-deposit endpoint is available only in the sandbox environment and is meant solely for testing purposes.

Finalize Quote Additional Topics