> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Simulate crypto deposit
> Simulate an incoming crypto deposit for testing purposes.
export const RestEndpointSubjects = ({subjects = []}) => {
const subjectToIconMap = {
'client': 'browser',
'user:individual': 'user',
'user:business': 'briefcase'
};
if (subjects.length === 0) {
return null;
}
return <>
{subjects.map(subject =>
{subject}
)}
;
};
This endpoint allows you to simulate a crypto deposit based on the details returned by the [Setup account deposit method](../set-up-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](./fund-sandbox-accounts) 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](/developer-guides/crypto-transfers/deposit/via-rest-api#handle-on-hold-transactions) for more details.
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json post /core/accounts/test-helpers/crypto-deposits
openapi: 3.1.0
info:
version: 0.1.0
title: Core API
description: >-
The Core API provides essential building blocks that empower businesses to
embed financial services into their applications.
contact:
name: Uphold API Team
email: developers@uphold.com
url: https://developer.uphold.com
servers:
- url: https://api.enterprise.sandbox.uphold.com
description: Sandbox
- url: https://api.enterprise.uphold.com
description: Production
security:
- OAuth2: []
tags:
- name: Authentication
description: Authentication.
- name: Countries
description: Countries.
- name: Users
description: Users.
- name: KYC
description: Individual User's KYC.
- name: KYB
description: Business User's KYB.
- name: Capabilities
description: User capabilities.
- name: Terms of service
description: User terms of service.
- name: Files
description: Files.
- name: Assets
description: Assets, networks and rails.
- name: Accounts
description: Accounts.
- name: External accounts
description: External accounts.
- name: Transactions
description: Transactions.
- name: Portfolio
description: Portfolio.
- name: Statements
description: Statements.
- name: Metadata
description: Metadata.
- name: Webhooks
description: Webhooks.
paths:
/core/accounts/test-helpers/crypto-deposits:
post:
tags:
- Accounts
summary: Simulate crypto deposit
description: Simulate an incoming crypto deposit for testing purposes.
operationId: core.simulate-crypto-deposit
requestBody:
$ref: '#/components/requestBodies/simulate-crypto-deposit-request-body'
responses:
'202':
$ref: '#/components/responses/simulate-crypto-deposit-response'
'404':
$ref: '#/components/responses/simulate-crypto-deposit-not-found-response'
'409':
$ref: '#/components/responses/simulate-crypto-deposit-conflict-response'
security:
- OAuth2:
- core.accounts:use-test-helpers
components:
requestBodies:
simulate-crypto-deposit-request-body:
content:
application/json:
schema:
type: object
properties:
network:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The crypto network used to process the simulated deposit.
address:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: >-
The destination crypto address for the simulated deposit
transaction.
reference:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: >-
The destination additional identifier (e.g., destination
tag, memo, or message) required for some networks such as
XRP (Ripple), XLM (Stellar), EOS, and others.
asset:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The asset of the simulated deposit transaction.
amount:
allOf:
- $ref: '#/components/schemas/non-zero-decimal-amount'
- description: The amount that was deposited in the simulation.
remitter:
description: The simulated sender's crypto account information.
type: object
additionalProperties: false
minProperties: 1
properties:
addresses:
description: >-
The crypto addresses from which the simulated funds were
sent.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/string-no-edge-spaces'
required:
- network
- address
- amount
- asset
examples:
Simulate BTC Crypto Deposit:
value:
network: bitcoin
address: tb1qjq4tvyjxkhpp0fp8lh8w3hhzwn4zue38hjjpkq
asset: BTC
amount: '0.001'
Simulate BTC Crypto Deposit With Remitter Addresses:
value:
network: bitcoin
address: tb1qjq4tvyjxkhpp0fp8lh8w3hhzwn4zue38hjjpkq
asset: BTC
amount: '0.001'
remitter:
addresses:
- 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa
- 3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy
Simulate XLM Crypto Deposit:
value:
network: stellar
address: GBPA3UQXMRWQALXUQBD66ZHX3Z7HQGHCTSMSNDHGRGHJPD7MYFGLYEC2
asset: XLM
amount: '10'
reference: '67809592'
Simulate XRP Crypto Deposit:
value:
network: xrp-ledger
address: rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY
asset: XRP
amount: '5'
reference: '12345'
remitter:
addresses:
- rD1syZmPdF6dRTpLfovfmiH4tMe56zxdYb
responses:
simulate-crypto-deposit-response:
description: Crypto deposit simulated.
content:
application/json:
schema:
type: object
properties:
cryptoDeposit:
type: object
properties:
network:
description: The crypto network used to process the simulated deposit.
type: string
address:
description: >-
The destination crypto address for the simulated deposit
transaction.
type: string
reference:
description: >-
The destination additional identifier (e.g., destination
tag, memo, or message) required for some networks such as
XRP (Ripple), XLM (Stellar), EOS, and others.
type: string
asset:
description: The asset of the simulated deposit transaction.
type: string
amount:
description: The amount that was deposited in the simulation.
type: string
remitter:
description: The simulated sender's crypto account information.
type: object
properties:
addresses:
description: >-
The crypto addresses from which the simulated funds
were sent.
type: array
items:
type: string
required:
- network
- address
- amount
- asset
required:
- cryptoDeposit
examples:
BTC Crypto Deposit Accepted:
value:
cryptoDeposit:
network: bitcoin
address: tb1qjq4tvyjxkhpp0fp8lh8w3hhzwn4zue38hjjpkq
asset: BTC
amount: '0.001'
XLM Crypto Deposit Accepted:
value:
cryptoDeposit:
network: stellar
address: GBPA3UQXMRWQALXUQBD66ZHX3Z7HQGHCTSMSNDHGRGHJPD7MYFGLYEC2
asset: XLM
amount: '10'
reference: '67809592'
XRP Crypto Deposit With Remitter Addresses Accepted:
value:
cryptoDeposit:
network: xrp-ledger
address: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh
asset: XRP
amount: '2'
reference: '67809592'
remitter:
addresses:
- rD1syZmPdF6dRTpLfovfmiH4tMe56zxdYb
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
simulate-crypto-deposit-not-found-response:
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Deposit Method Not Found:
value:
code: entity_not_found
message: The account deposit method cannot be found
details:
entity: depositMethod
Rail Not Found:
value:
code: entity_not_found
message: >-
A rail for the specified type, asset and network cannot be
found
details:
entity: rail
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
simulate-crypto-deposit-conflict-response:
description: Business logic error.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Crypto Address Invalid:
value:
code: crypto_address_invalid
message: The crypto address is invalid
details:
context: body
property: address
Rail Missing Deposit Feature:
value:
code: rail_feature_not_available
message: The 'deposit' feature is not available for the rail
details:
feature: deposit
Amount Minimum Limit Not Met:
value:
code: transaction_amount_invalid
message: The amount minimum limit was not met
details:
context: body
property: amount
rule: minimum-limit-not-met
threshold:
value: 10
Remitter Addresses Invalid:
value:
code: crypto_address_invalid
message: The crypto address is invalid
details:
context: body
property: remitter.addresses
Remitter Addresses Limit Exceeded:
value:
code: crypto_address_invalid
message: The number of addresses must be less than or equal to 1
details:
context: body
property: remitter.addresses,
threshold:
limit: 1
Remitter And Recipient Cannot Match:
value:
code: remitter_and_recipient_cannot_match
message: The remitter and recipient cannot match
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
schemas:
string-no-edge-spaces:
type: string
pattern: ^\S.*\S$|^\S$
non-zero-decimal-amount:
type: string
pattern: ^(?!0+(\.0+)?$)\d+(\.\d+)?$
error:
description: The error information.
allOf:
- $ref: '#/components/schemas/feedback'
feedback:
description: A feedback message with a code and human-readable description.
type: object
properties:
code:
description: A short string with a brief explanation about the code reported.
type: string
message:
description: A human-readable message providing more details.
type: string
details:
description: Additional information about the feedback reported.
type: object
additionalProperties: true
required:
- code
- message
securitySchemes:
OAuth2:
type: oauth2
description: OAuth 2.0 authentication.
flows:
clientCredentials:
tokenUrl: /core/oauth2/token
scopes:
core.users:act-on-behalf-of: Grants access to act on behalf of a user
core.users:create: Grants access to create users
core.users:read: Grants access to view users
core.users:delete: Grants access to delete users
core.users.metadata:read: Grants access to view user metadata
core.users.metadata:write: Grants access to modify user metadata
core.kyc:read: Grants access to view KYC processes
core.kyc.profile:update: Grants access to update profile KYC process
core.kyc.address:update: Grants access to update address KYC process
core.kyc.email:update: Grants access to update email KYC process
core.kyc.phone:update: Grants access to update phone KYC process
core.kyc.identity:update: Grants access to update identity KYC process
core.kyc.proof-of-address:update: Grants access to update proof-of-address KYC process
core.kyc.customer-due-diligence:update: Grants access to update customer due diligence KYC process
core.kyc.enhanced-due-diligence:update: Grants access to update enhanced due diligence KYC process
core.kyc.crypto-risk-assessment:update: Grants access to update crypto risk assessment KYC process
core.kyc.self-categorization-statement:update: Grants access to update self-categorization statement KYC process
core.kyc.tax-details:update: Grants access to update tax details KYC process
core.capabilities:read: Grants access to view user capabilities
core.terms-of-service:read: Grants access to view terms of service
core.terms-of-service:accept: Grants access to accept terms of service
core.files:create: Grants access to create files
core.files:read: Grants access to view files
core.files.metadata:read: Grants access to view files metadata
core.files.metadata:write: Grants access to modify files metadata
core.accounts:create: Grants access to create accounts
core.accounts:read: Grants access to view accounts
core.accounts:update: Grants access to update accounts
core.accounts:archive: Grants access to archive accounts
core.accounts:deposit-method: >-
Grants access to deposit method needed for depositing into
accounts
core.accounts:use-test-helpers: Grants access to test helpers of accounts
core.accounts.metadata:read: Grants access to view accounts metadata
core.accounts.metadata:write: Grants access to modify accounts metadata
core.assets:use-test-helpers: Grants access to test helpers of assets
core.external-accounts:create: Grants access to create external accounts
core.external-accounts:read: Grants access to view external accounts
core.external-accounts:update: Grants access to update external accounts
core.external-accounts:delete: Grants access to delete external accounts
core.external-accounts.metadata:read: Grants access to view external accounts metadata
core.external-accounts.metadata:write: Grants access to modify external accounts metadata
core.transactions:create: Grants access to commit quotes
core.transactions:read: Grants access to view transactions
core.transactions.metadata:read: Grants access to view transactions metadata
core.transactions.metadata:write: Grants access to modify transactions metadata
core.transactions.requests-for-information:read: Grants access to view transactions requests for information
core.transactions.requests-for-information:update: Grants access to update transactions requests for information
core.portfolio:read: >-
Grants access to view portfolio overview, performance, and
historical balance
core.statements:read: Grants access to read statements
core.webhooks:management-link: Grants access to create webhook management links
````