Ctrl+K

Get bank account

get/api/v2/bankaccounts/{bankAccountId}

This route is potentially useful for finding the 'idHash' of the desired account to use for fiat withdrawals. The 'idHash' field is used as the recipient address along with an optional hyphen separator and memo (example: '5812dcaa9a285aa6-memohere').

Path Parameters

  • bankAccountIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$ OR UUID

200 Response

accountNumber string
Bank account number or IBAN.
Min length: >= 1 characters
Max length: <= 34 characters
Example: 0114584906
enterpriseId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
address string
Example: 2390 El Camino Real, Palo Alto, CA 94306
address1 string
Example: 2390 El Camino Real
address2 string
Example: Palo Alto, CA 94306
address3 string
Example:
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
name string
Example: America California Bank
ownerName string
Example: Donald E. Knuth
ownerAddress string
Example: 2390 El Camino Real, Palo Alto, CA 94306
owner object
Bank account owner
name string required
Example: Donald E. Knuth
address1 string required
Example: Computer Science Department
address2 string
Example: Stanford University
address3 string
Example: Stanford, CA 94305-9045
routingNumber string
US bank routing number
Min length: >= 9 characters
Max length: <= 9 characters
Example: 129131673
Match pattern: ^[0-9]+$
shortCountryCode string
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
swiftCode string
Bank identifier code, as specified by ISO 9362. Used by banks outside the US.
Min length: >= 8 characters
Max length: <= 11 characters
Example: DEUTDEFF500
Match pattern: ^[A-Z]{6}[0-9A-Z]{2}([0-9A-Z]{3})?$
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
externalId string
Example: a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
furtherCreditTo string
Example: Donald E. Knuth
intermediaryBankName string
Example: America California Bank
intermediaryBankId string
Example: 59cd72485007a239fb00282ed480da1f
idHash string
Unique identifier for this account, derived from 'accountNumber', 'routingNumber', and 'swiftCode'
Example: 5c645791cf8eb19304292a8e3365fee3
trustOrg string
BitGo Organization related to this entity
Allowed values: BitGo Inc BitGo Trust BitGo New York BitGo Germany BitGo Switzerland Frankfurt DE Trust BitGo Sister Trust 1 BitGo Korea BitGo Singapore
token string
Example: fiat
verificationState string
Allowed values: pending approved rejected removed
pendingActivity string
Allowed value: trust
fee object
A fee that's associated with a bank account.
feeInfo object

400 Response

error string required
errorName string required

401 Response

error string required
errorName string required

403 Response

error string required
errorName string required

404 Response

error string required
errorName string required

500 Response

error string required
errorName string required