API Reference

Wallets

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Modular Wallets

Transfers

UserOps

Wallets

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Get a deposit by ID

gethttps://api-sandbox.circle.com/v1/businessAccount/deposits/{id}

Reference
Playground

Returns a deposit by ID.

Path parameters

uuid

Required

Universally unique identifier (UUID v4) of a resource.

Query parameters

type

string

Filters results to get only deposits made by this specific type.

walletId

string

The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account.

Response

200

Response Body

object

string

Required

Unique system generated identifier for the entity.

sourceWalletId

string

The identifier for the bank account where the funds were deposited from.

destination

object

Required

Show 2 properties

type

string

Required

Allowed valueswallet

string

Required

The id of the wallet.

amount

object

Required

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSDEURMXNSGDBRL

fee

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSD

status

string

Required

Status of the deposit. Status pending indicates that the deposit is in the process of running; complete indicates it finished successfully; failed indicates it failed.

Allowed valuespendingcompletefailed

riskEvaluation

object

Results of risk evaluation. Only present if the payment is denied by Circle's risk service.

Show 2 properties

decision

string

Enumerated decision of the account.

Allowed valuesapproveddeniedreview

reason

string

Risk reason for the definitive decision outcome.

customerExternalRef

string

A reference to the external customer which is in the memo field of the fiat transfer.

createDate

string

Required

ISO-8601 UTC date/time format.

updateDate

string

ISO-8601 UTC date/time format.

401NotAuthorized

404NotFound

RequestChoose a language

ResponseChoose an example

1{
2  "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
3  "sourceWalletId": "9b57048d-2365-4ff5-956b-0199170d1035",
4  "destination": {
5    "type": "wallet",
6    "id": "12345"
7  },
8  "amount": {
9    "amount": "3.14",
10    "currency": "USD"
11  },
12  "fee": {
13    "amount": "3.14",
14    "currency": "USD"
15  },
16  "status": "pending",
17  "riskEvaluation": {
18    "decision": "approved",
19    "reason": "3000"
20  },
21  "customerExternalRef": "EXT01ABSJKDKASJHDS922",
22  "createDate": "2020-04-10T02:13:30.000Z",
23  "updateDate": "2020-04-10T02:13:30.000Z"
24}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy