Skip to main content
POST
/
core
/
accounts
/
test-helpers
/
crypto-deposits
curl --request POST \
  --url https://api.enterprise.sandbox.uphold.com/core/accounts/test-helpers/crypto-deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network": "bitcoin",
  "address": "tb1qjq4tvyjxkhpp0fp8lh8w3hhzwn4zue38hjjpkq",
  "asset": "BTC",
  "amount": "0.001"
}
'
{
  "cryptoDeposit": {
    "network": "bitcoin",
    "address": "tb1qjq4tvyjxkhpp0fp8lh8w3hhzwn4zue38hjjpkq",
    "asset": "BTC",
    "amount": "0.001"
  }
}
This endpoint allows you to simulate a crypto deposit based on the details returned by the Setup account deposit method endpoint. It is useful for testing how your application handles incoming crypto deposits without needing to perform an actual testnet transfer. Since this is a simulated deposit and does not use a real testnet, the transaction hash will not be available on the blockchain. Check out Testnets and token faucets for instructions on how to fund your Sandbox account using an actual testnet transaction.
Depending on the country and/or the amount, the simulated crypto deposit may be placed on-hold pending Requests for Information (RFIs). See Handle on-hold transactions for more details.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Body

application/json
​
network
string
required

The crypto network used to process the simulated deposit.

Pattern: ^\S.*\S$|^\S$
​
address
string
required

The destination crypto address for the simulated deposit transaction.

Pattern: ^\S.*\S$|^\S$
​
asset
string
required

The asset of the simulated deposit transaction.

Pattern: ^\S.*\S$|^\S$
​
amount
string
required

The amount that was deposited in the simulation.

Pattern: ^\d+(\.\d+)?$
​
reference
string

The destination additional identifier (e.g., destination tag, memo, or message) required for some networks such as XRP (Ripple), XLM (Stellar), EOS, and others.

Pattern: ^\S.*\S$|^\S$
​
remitter
object

The simulated sender's crypto account information.

Response

Crypto deposit simulated.

​
cryptoDeposit
object
required