Ctrl+K

Get deposit information

get/api/v2/{coin}/wallet/{walletId}/depositinfo

Collects all information needed for a deposit.

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: btc
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

200 Response

toAddress string required
The address the deposit will be received at
Example: 1234567890ABCDEF-XJBCOEF
valueString string
The value (in cents/base units) of the deposit
Example: 2000000
Match pattern: ^-?\d+$
token string required
If this is a token entry, the token's symbol
Example: ousd
toBankAccountAny of
An external bank account. `routingNumber` must be set for US bank accounts. `swiftCode` must be set for banks outside the US.
accountNumber string required
Bank account number or IBAN.
Min length: >= 1 characters
Max length: <= 34 characters
Example: 114584906
enterpriseId string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
address string
Example: 2390 El Camino Real, Palo Alto, CA 94306
address1 string required
Example: 2390 El Camino Real
address2 string
Example: Palo Alto, CA 94306
address3 string
Example:
name string required
Example: America California Bank
ownerName string
Example: Donald E. Knuth
ownerAddress string
Example: 2390 El Camino Real, Palo Alto, CA 94306
owner object required
Bank account owner
routingNumber string required
US bank routing number. Required for domestic wire transfers within the US.
Min length: >= 9 characters
Max length: <= 9 characters
Example: 129131673
Match pattern: ^[0-9]+$
shortCountryCode string required
Two-letter country code, as specified by ISO 3166-1 alpha-2
Min length: >= 2 characters
Max length: <= 2 characters
Allowed values: AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
Example: US
type
string or null
The type of bank account. If null, defaults `wire`.
Allowed values: wire cbit null
Example: wire
currency
string or null
The currency of the bank account. If null, defaults to `fiatusd`.
Allowed values: fiatusd fiateur null
Example: fiatusd
furtherCreditTo string
Example: Donald E. Knuth
intermediaryBankName string
Example: America California Bank
intermediaryBankId string
Example: 59cd72485007a239fb00282ed480da1f

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code