Accounts

Simulate crypto deposit

Simulate an incoming crypto deposit for testing purposes.

post/core/accounts/test-helpers/crypto-deposits

Request

Base URL
https://api.enterprise.sandbox.uphold.com
Auth
OAuth 2
Client credentials
Token URL/core/oauth2/token
Scopescore.accounts:use-test-helpers
TypeScript
https://skmtc.dev/uphold/apis/core-api/docs/core/accounts/test-helpers/crypto-deposits/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

X-On-Behalf-Ofstring

The subject on whose behalf the operation is being performed.

string ipv4

string ipv6

Contains the IP of the end user that is requesting the operation.

X-Uphold-User-Agentstring

Contains the user agent of the end user that is requesting the operation.

X-Uphold-User-Originstring

Contains the origin of the request made by the end user.

X-Uphold-User-Countrystring

Contains the code of the country of the end user that is requesting the operation.

X-Uphold-User-Subdivisionstring

Contains the code of the subdivision of the end user that is requesting the operation.

X-Uphold-User-Citystring

Contains the name of the city of the end user that is requesting the operation.

Request body

networkstring required

The crypto network used to process the simulated deposit.

addressstring required

The destination crypto address for the simulated deposit transaction.

referencestring

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

assetstring required

The asset of the simulated deposit transaction.

amountstring required

The amount that was deposited in the simulation.

Response

Crypto deposit simulated.

Changes

No recorded changes to this operation across all 1 revision of this API.