GET
List bank accounts
List all bank accounts associated with a BitGo enterprise.
Query Params
-
bankAccountIdstring -
bankAccountIdHasharray of strings -
enterpriseIdarray of strings -
idHasharray of strings -
verificationStatestring enumapprovedrejectedpendingremovedrevise -
trustOrgstring enumBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1 -
typestring enumwirecbitachblincswiftsepa
Responses
200
OK
Response Body
object
codec for get bank accounts http response
-
bankAccountsarray of objects requiredUnified schema for an array of bank accountsONE OF
- DomesticWireBankAccountResponse
- InternationalWireBankAccountResponse
- CbitBankAccountResponse
- AchBankAccountResponse
- SepaBankAccountResponse
- BlincBankAccountResponse
- IpiFtsBankAccountResponse
- FastBankAccountResponse
No matching variants
-
typestring enum requiredwire -
routingNumberstring required -
accountTypestring enum nullable requiredcheckingsavingunknown -
idstring requiredUnique identifier for the bank account -
idHashstring requiredHashed identifier for the bank account -
currencystring enum requiredThe currency of the bank accountfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
tokenstring requiredAuthentication token for bank account operations -
namestring requiredName of the bank account -
shortCountryCodestring requiredTwo-letter ISO country code -
accountNumberstring requiredBank account number (may be masked) -
enterpriseIdstring requiredID of the enterprise the account belongs to -
trustOrgstring enum requiredTrust organization associated with this accountBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1 -
ownerNamestring requiredName of the account owner -
verificationStatestring enum requiredCurrent verification status of the accountapprovedrejectedpendingremovedrevise -
createdAtstring date-time requiredTimestamp when the account was created -
pendingActivitystringAny pending activity on the accountONE OF
string enum
string enum
-
feeobjectFee information for the accountfee object
-
amountstring -
individualFeesarray of objects requiredONE OF
-
typestring enum requiredstatic -
amountstring required
-
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
-
feeInfoobjectDetailed fee configuration for the accountONE OF
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredstatic -
amountstring required
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
furtherCreditTostringFurther credit recipient information -
intermediaryBankNamestringName of intermediary bank if applicable -
intermediaryBankIdstringIdentifier of the intermediary bank -
metadatastringAdditional metadata for the account -
descriptionstringUser-provided description of the account -
virtualDepositOnlybooleanWhether this account is for virtual deposits only -
ownerAddressLine1string nullableFirst line of owner's address (street number and name) -
ownerAddressLine2string nullableSecond line of owner's address (apartment/suite number, etc.) -
ownerAddressCityLocalitystring nullableCity or locality of owner's address -
ownerAddressStateProvincestring nullableState or province of owner's address -
ownerAddressPostalCodestring nullablePostal code of owner's address -
ownerAddressCountryCodestring nullableTwo-letter ISO country code of owner's address -
bankAddressLine1string nullableFirst line of bank's address (street number and name) -
bankAddressLine2string nullableSecond line of bank's address (branch information, etc.) -
bankAddressCityLocalitystring nullableCity or locality of bank's address -
bankAddressStateProvincestring nullableState or province of bank's address -
bankAddressPostalCodestring nullablePostal code of bank's address -
bankAddressCountryCodestring nullableTwo-letter ISO country code of bank's address, should equal shortCountryCode -
ownerobjectDEPRECATED - Use ownerName and normalized address fields insteadowner object
-
namestring deprecatedDEPRECATED - Use ownerName instead -
address1object deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2object deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3object deprecatedDEPRECATED - Use additional normalized address fields instead
-
-
addressstring deprecatedDEPRECATED - Use normalized bank address fields instead -
ownerAddressstring deprecatedDEPRECATED - Use normalized owner address fields instead -
address1string deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2string deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3string deprecatedDEPRECATED - Use additional normalized address fields instead
-
typestring enum requiredwire -
swiftCodestring required -
accountTypestring enum nullable requiredcheckingsavingunknown -
idstring requiredUnique identifier for the bank account -
idHashstring requiredHashed identifier for the bank account -
currencystring enum requiredThe currency of the bank accountfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
tokenstring requiredAuthentication token for bank account operations -
namestring requiredName of the bank account -
shortCountryCodestring requiredTwo-letter ISO country code -
accountNumberstring requiredBank account number (may be masked) -
enterpriseIdstring requiredID of the enterprise the account belongs to -
trustOrgstring enum requiredTrust organization associated with this accountBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1 -
ownerNamestring requiredName of the account owner -
verificationStatestring enum requiredCurrent verification status of the accountapprovedrejectedpendingremovedrevise -
createdAtstring date-time requiredTimestamp when the account was created -
pendingActivitystringAny pending activity on the accountONE OF
string enum
string enum
-
feeobjectFee information for the accountfee object
-
amountstring -
individualFeesarray of objects requiredONE OF
-
typestring enum requiredstatic -
amountstring required
-
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
-
feeInfoobjectDetailed fee configuration for the accountONE OF
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredstatic -
amountstring required
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
furtherCreditTostringFurther credit recipient information -
intermediaryBankNamestringName of intermediary bank if applicable -
intermediaryBankIdstringIdentifier of the intermediary bank -
metadatastringAdditional metadata for the account -
descriptionstringUser-provided description of the account -
virtualDepositOnlybooleanWhether this account is for virtual deposits only -
ownerAddressLine1string nullableFirst line of owner's address (street number and name) -
ownerAddressLine2string nullableSecond line of owner's address (apartment/suite number, etc.) -
ownerAddressCityLocalitystring nullableCity or locality of owner's address -
ownerAddressStateProvincestring nullableState or province of owner's address -
ownerAddressPostalCodestring nullablePostal code of owner's address -
ownerAddressCountryCodestring nullableTwo-letter ISO country code of owner's address -
bankAddressLine1string nullableFirst line of bank's address (street number and name) -
bankAddressLine2string nullableSecond line of bank's address (branch information, etc.) -
bankAddressCityLocalitystring nullableCity or locality of bank's address -
bankAddressStateProvincestring nullableState or province of bank's address -
bankAddressPostalCodestring nullablePostal code of bank's address -
bankAddressCountryCodestring nullableTwo-letter ISO country code of bank's address, should equal shortCountryCode -
ownerobjectDEPRECATED - Use ownerName and normalized address fields insteadowner object
-
namestring deprecatedDEPRECATED - Use ownerName instead -
address1object deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2object deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3object deprecatedDEPRECATED - Use additional normalized address fields instead
-
-
addressstring deprecatedDEPRECATED - Use normalized bank address fields instead -
ownerAddressstring deprecatedDEPRECATED - Use normalized owner address fields instead -
address1string deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2string deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3string deprecatedDEPRECATED - Use additional normalized address fields instead
-
typestring enum requiredcbit -
accountTypestring enum nullable requiredcheckingsavingunknown -
externalIdstring -
idstring requiredUnique identifier for the bank account -
idHashstring requiredHashed identifier for the bank account -
currencystring enum requiredThe currency of the bank accountfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
tokenstring requiredAuthentication token for bank account operations -
namestring requiredName of the bank account -
shortCountryCodestring requiredTwo-letter ISO country code -
accountNumberstring requiredBank account number (may be masked) -
enterpriseIdstring requiredID of the enterprise the account belongs to -
trustOrgstring enum requiredTrust organization associated with this accountBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1 -
ownerNamestring requiredName of the account owner -
verificationStatestring enum requiredCurrent verification status of the accountapprovedrejectedpendingremovedrevise -
createdAtstring date-time requiredTimestamp when the account was created -
pendingActivitystringAny pending activity on the accountONE OF
string enum
string enum
-
feeobjectFee information for the accountfee object
-
amountstring -
individualFeesarray of objects requiredONE OF
-
typestring enum requiredstatic -
amountstring required
-
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
-
feeInfoobjectDetailed fee configuration for the accountONE OF
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredstatic -
amountstring required
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
furtherCreditTostringFurther credit recipient information -
intermediaryBankNamestringName of intermediary bank if applicable -
intermediaryBankIdstringIdentifier of the intermediary bank -
metadatastringAdditional metadata for the account -
descriptionstringUser-provided description of the account -
virtualDepositOnlybooleanWhether this account is for virtual deposits only -
ownerAddressLine1string nullableFirst line of owner's address (street number and name) -
ownerAddressLine2string nullableSecond line of owner's address (apartment/suite number, etc.) -
ownerAddressCityLocalitystring nullableCity or locality of owner's address -
ownerAddressStateProvincestring nullableState or province of owner's address -
ownerAddressPostalCodestring nullablePostal code of owner's address -
ownerAddressCountryCodestring nullableTwo-letter ISO country code of owner's address -
bankAddressLine1string nullableFirst line of bank's address (street number and name) -
bankAddressLine2string nullableSecond line of bank's address (branch information, etc.) -
bankAddressCityLocalitystring nullableCity or locality of bank's address -
bankAddressStateProvincestring nullableState or province of bank's address -
bankAddressPostalCodestring nullablePostal code of bank's address -
bankAddressCountryCodestring nullableTwo-letter ISO country code of bank's address, should equal shortCountryCode -
ownerobjectDEPRECATED - Use ownerName and normalized address fields insteadowner object
-
namestring deprecatedDEPRECATED - Use ownerName instead -
address1object deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2object deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3object deprecatedDEPRECATED - Use additional normalized address fields instead
-
-
addressstring deprecatedDEPRECATED - Use normalized bank address fields instead -
ownerAddressstring deprecatedDEPRECATED - Use normalized owner address fields instead -
address1string deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2string deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3string deprecatedDEPRECATED - Use additional normalized address fields instead
-
typestring enum requiredach -
routingNumberstring required -
accountTypestring enum nullable requiredcheckingsavingunknown -
idstring requiredUnique identifier for the bank account -
idHashstring requiredHashed identifier for the bank account -
currencystring enum requiredThe currency of the bank accountfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
tokenstring requiredAuthentication token for bank account operations -
namestring requiredName of the bank account -
shortCountryCodestring requiredTwo-letter ISO country code -
accountNumberstring requiredBank account number (may be masked) -
enterpriseIdstring requiredID of the enterprise the account belongs to -
trustOrgstring enum requiredTrust organization associated with this accountBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1 -
ownerNamestring requiredName of the account owner -
verificationStatestring enum requiredCurrent verification status of the accountapprovedrejectedpendingremovedrevise -
createdAtstring date-time requiredTimestamp when the account was created -
pendingActivitystringAny pending activity on the accountONE OF
string enum
string enum
-
feeobjectFee information for the accountfee object
-
amountstring -
individualFeesarray of objects requiredONE OF
-
typestring enum requiredstatic -
amountstring required
-
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
-
feeInfoobjectDetailed fee configuration for the accountONE OF
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredstatic -
amountstring required
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
furtherCreditTostringFurther credit recipient information -
intermediaryBankNamestringName of intermediary bank if applicable -
intermediaryBankIdstringIdentifier of the intermediary bank -
metadatastringAdditional metadata for the account -
descriptionstringUser-provided description of the account -
virtualDepositOnlybooleanWhether this account is for virtual deposits only -
ownerAddressLine1string nullableFirst line of owner's address (street number and name) -
ownerAddressLine2string nullableSecond line of owner's address (apartment/suite number, etc.) -
ownerAddressCityLocalitystring nullableCity or locality of owner's address -
ownerAddressStateProvincestring nullableState or province of owner's address -
ownerAddressPostalCodestring nullablePostal code of owner's address -
ownerAddressCountryCodestring nullableTwo-letter ISO country code of owner's address -
bankAddressLine1string nullableFirst line of bank's address (street number and name) -
bankAddressLine2string nullableSecond line of bank's address (branch information, etc.) -
bankAddressCityLocalitystring nullableCity or locality of bank's address -
bankAddressStateProvincestring nullableState or province of bank's address -
bankAddressPostalCodestring nullablePostal code of bank's address -
bankAddressCountryCodestring nullableTwo-letter ISO country code of bank's address, should equal shortCountryCode -
ownerobjectDEPRECATED - Use ownerName and normalized address fields insteadowner object
-
namestring deprecatedDEPRECATED - Use ownerName instead -
address1object deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2object deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3object deprecatedDEPRECATED - Use additional normalized address fields instead
-
-
addressstring deprecatedDEPRECATED - Use normalized bank address fields instead -
ownerAddressstring deprecatedDEPRECATED - Use normalized owner address fields instead -
address1string deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2string deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3string deprecatedDEPRECATED - Use additional normalized address fields instead
-
typestring enum requiredsepa -
swiftCodestring required -
accountTypestring enum nullable requiredcheckingsavingunknown -
idstring requiredUnique identifier for the bank account -
idHashstring requiredHashed identifier for the bank account -
currencystring enum requiredThe currency of the bank accountfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
tokenstring requiredAuthentication token for bank account operations -
namestring requiredName of the bank account -
shortCountryCodestring requiredTwo-letter ISO country code -
accountNumberstring requiredBank account number (may be masked) -
enterpriseIdstring requiredID of the enterprise the account belongs to -
trustOrgstring enum requiredTrust organization associated with this accountBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1 -
ownerNamestring requiredName of the account owner -
verificationStatestring enum requiredCurrent verification status of the accountapprovedrejectedpendingremovedrevise -
createdAtstring date-time requiredTimestamp when the account was created -
pendingActivitystringAny pending activity on the accountONE OF
string enum
string enum
-
feeobjectFee information for the accountfee object
-
amountstring -
individualFeesarray of objects requiredONE OF
-
typestring enum requiredstatic -
amountstring required
-
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
-
feeInfoobjectDetailed fee configuration for the accountONE OF
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredstatic -
amountstring required
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
furtherCreditTostringFurther credit recipient information -
intermediaryBankNamestringName of intermediary bank if applicable -
intermediaryBankIdstringIdentifier of the intermediary bank -
metadatastringAdditional metadata for the account -
descriptionstringUser-provided description of the account -
virtualDepositOnlybooleanWhether this account is for virtual deposits only -
ownerAddressLine1string nullableFirst line of owner's address (street number and name) -
ownerAddressLine2string nullableSecond line of owner's address (apartment/suite number, etc.) -
ownerAddressCityLocalitystring nullableCity or locality of owner's address -
ownerAddressStateProvincestring nullableState or province of owner's address -
ownerAddressPostalCodestring nullablePostal code of owner's address -
ownerAddressCountryCodestring nullableTwo-letter ISO country code of owner's address -
bankAddressLine1string nullableFirst line of bank's address (street number and name) -
bankAddressLine2string nullableSecond line of bank's address (branch information, etc.) -
bankAddressCityLocalitystring nullableCity or locality of bank's address -
bankAddressStateProvincestring nullableState or province of bank's address -
bankAddressPostalCodestring nullablePostal code of bank's address -
bankAddressCountryCodestring nullableTwo-letter ISO country code of bank's address, should equal shortCountryCode -
ownerobjectDEPRECATED - Use ownerName and normalized address fields insteadowner object
-
namestring deprecatedDEPRECATED - Use ownerName instead -
address1object deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2object deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3object deprecatedDEPRECATED - Use additional normalized address fields instead
-
-
addressstring deprecatedDEPRECATED - Use normalized bank address fields instead -
ownerAddressstring deprecatedDEPRECATED - Use normalized owner address fields instead -
address1string deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2string deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3string deprecatedDEPRECATED - Use additional normalized address fields instead
-
typestring enum requiredblinc -
accountTypestring enum nullable requiredcheckingsavingunknown -
externalIdstring required -
idstring requiredUnique identifier for the bank account -
idHashstring requiredHashed identifier for the bank account -
currencystring enum requiredThe currency of the bank accountfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
tokenstring requiredAuthentication token for bank account operations -
namestring requiredName of the bank account -
shortCountryCodestring requiredTwo-letter ISO country code -
accountNumberstring requiredBank account number (may be masked) -
enterpriseIdstring requiredID of the enterprise the account belongs to -
trustOrgstring enum requiredTrust organization associated with this accountBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1 -
ownerNamestring requiredName of the account owner -
verificationStatestring enum requiredCurrent verification status of the accountapprovedrejectedpendingremovedrevise -
createdAtstring date-time requiredTimestamp when the account was created -
pendingActivitystringAny pending activity on the accountONE OF
string enum
string enum
-
feeobjectFee information for the accountfee object
-
amountstring -
individualFeesarray of objects requiredONE OF
-
typestring enum requiredstatic -
amountstring required
-
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
-
feeInfoobjectDetailed fee configuration for the accountONE OF
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredstatic -
amountstring required
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
furtherCreditTostringFurther credit recipient information -
intermediaryBankNamestringName of intermediary bank if applicable -
intermediaryBankIdstringIdentifier of the intermediary bank -
metadatastringAdditional metadata for the account -
descriptionstringUser-provided description of the account -
virtualDepositOnlybooleanWhether this account is for virtual deposits only -
ownerAddressLine1string nullableFirst line of owner's address (street number and name) -
ownerAddressLine2string nullableSecond line of owner's address (apartment/suite number, etc.) -
ownerAddressCityLocalitystring nullableCity or locality of owner's address -
ownerAddressStateProvincestring nullableState or province of owner's address -
ownerAddressPostalCodestring nullablePostal code of owner's address -
ownerAddressCountryCodestring nullableTwo-letter ISO country code of owner's address -
bankAddressLine1string nullableFirst line of bank's address (street number and name) -
bankAddressLine2string nullableSecond line of bank's address (branch information, etc.) -
bankAddressCityLocalitystring nullableCity or locality of bank's address -
bankAddressStateProvincestring nullableState or province of bank's address -
bankAddressPostalCodestring nullablePostal code of bank's address -
bankAddressCountryCodestring nullableTwo-letter ISO country code of bank's address, should equal shortCountryCode -
ownerobjectDEPRECATED - Use ownerName and normalized address fields insteadowner object
-
namestring deprecatedDEPRECATED - Use ownerName instead -
address1object deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2object deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3object deprecatedDEPRECATED - Use additional normalized address fields instead
-
-
addressstring deprecatedDEPRECATED - Use normalized bank address fields instead -
ownerAddressstring deprecatedDEPRECATED - Use normalized owner address fields instead -
address1string deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2string deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3string deprecatedDEPRECATED - Use additional normalized address fields instead
-
typestring enum requiredipi-fts -
swiftCodestring required -
accountTypestring enum nullable requiredcheckingsavingunknown -
idstring requiredUnique identifier for the bank account -
idHashstring requiredHashed identifier for the bank account -
currencystring enum requiredThe currency of the bank accountfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
tokenstring requiredAuthentication token for bank account operations -
namestring requiredName of the bank account -
shortCountryCodestring requiredTwo-letter ISO country code -
accountNumberstring requiredBank account number (may be masked) -
enterpriseIdstring requiredID of the enterprise the account belongs to -
trustOrgstring enum requiredTrust organization associated with this accountBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1 -
ownerNamestring requiredName of the account owner -
verificationStatestring enum requiredCurrent verification status of the accountapprovedrejectedpendingremovedrevise -
createdAtstring date-time requiredTimestamp when the account was created -
pendingActivitystringAny pending activity on the accountONE OF
string enum
string enum
-
feeobjectFee information for the accountfee object
-
amountstring -
individualFeesarray of objects requiredONE OF
-
typestring enum requiredstatic -
amountstring required
-
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
-
feeInfoobjectDetailed fee configuration for the accountONE OF
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredstatic -
amountstring required
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
furtherCreditTostringFurther credit recipient information -
intermediaryBankNamestringName of intermediary bank if applicable -
intermediaryBankIdstringIdentifier of the intermediary bank -
metadatastringAdditional metadata for the account -
descriptionstringUser-provided description of the account -
virtualDepositOnlybooleanWhether this account is for virtual deposits only -
ownerAddressLine1string nullableFirst line of owner's address (street number and name) -
ownerAddressLine2string nullableSecond line of owner's address (apartment/suite number, etc.) -
ownerAddressCityLocalitystring nullableCity or locality of owner's address -
ownerAddressStateProvincestring nullableState or province of owner's address -
ownerAddressPostalCodestring nullablePostal code of owner's address -
ownerAddressCountryCodestring nullableTwo-letter ISO country code of owner's address -
bankAddressLine1string nullableFirst line of bank's address (street number and name) -
bankAddressLine2string nullableSecond line of bank's address (branch information, etc.) -
bankAddressCityLocalitystring nullableCity or locality of bank's address -
bankAddressStateProvincestring nullableState or province of bank's address -
bankAddressPostalCodestring nullablePostal code of bank's address -
bankAddressCountryCodestring nullableTwo-letter ISO country code of bank's address, should equal shortCountryCode -
ownerobjectDEPRECATED - Use ownerName and normalized address fields insteadowner object
-
namestring deprecatedDEPRECATED - Use ownerName instead -
address1object deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2object deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3object deprecatedDEPRECATED - Use additional normalized address fields instead
-
-
addressstring deprecatedDEPRECATED - Use normalized bank address fields instead -
ownerAddressstring deprecatedDEPRECATED - Use normalized owner address fields instead -
address1string deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2string deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3string deprecatedDEPRECATED - Use additional normalized address fields instead
-
typestring enum requiredfast -
swiftCodestring required -
accountTypestring enum nullable requiredcheckingsavingunknown -
idstring requiredUnique identifier for the bank account -
idHashstring requiredHashed identifier for the bank account -
currencystring enum requiredThe currency of the bank accountfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
tokenstring requiredAuthentication token for bank account operations -
namestring requiredName of the bank account -
shortCountryCodestring requiredTwo-letter ISO country code -
accountNumberstring requiredBank account number (may be masked) -
enterpriseIdstring requiredID of the enterprise the account belongs to -
trustOrgstring enum requiredTrust organization associated with this accountBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1 -
ownerNamestring requiredName of the account owner -
verificationStatestring enum requiredCurrent verification status of the accountapprovedrejectedpendingremovedrevise -
createdAtstring date-time requiredTimestamp when the account was created -
pendingActivitystringAny pending activity on the accountONE OF
string enum
string enum
-
feeobjectFee information for the accountfee object
-
amountstring -
individualFeesarray of objects requiredONE OF
-
typestring enum requiredstatic -
amountstring required
-
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
-
feeInfoobjectDetailed fee configuration for the accountONE OF
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredstatic -
amountstring required
-
coinstring enum requiredfiatusdfiateurfiatsgdfiataedtfiatusdtfiateurtfiatsgdtfiataed -
bankstring enum requiredsilvergatesilvergate_primesilvergate_v3silvergate_prime_v3bcbgroupsignaturegenericcustomers_apicustomers_cubix_apicustomers_sftplead -
typestring enum requiredvariable -
percentstring required -
minimumstring required
-
-
furtherCreditTostringFurther credit recipient information -
intermediaryBankNamestringName of intermediary bank if applicable -
intermediaryBankIdstringIdentifier of the intermediary bank -
metadatastringAdditional metadata for the account -
descriptionstringUser-provided description of the account -
virtualDepositOnlybooleanWhether this account is for virtual deposits only -
ownerAddressLine1string nullableFirst line of owner's address (street number and name) -
ownerAddressLine2string nullableSecond line of owner's address (apartment/suite number, etc.) -
ownerAddressCityLocalitystring nullableCity or locality of owner's address -
ownerAddressStateProvincestring nullableState or province of owner's address -
ownerAddressPostalCodestring nullablePostal code of owner's address -
ownerAddressCountryCodestring nullableTwo-letter ISO country code of owner's address -
bankAddressLine1string nullableFirst line of bank's address (street number and name) -
bankAddressLine2string nullableSecond line of bank's address (branch information, etc.) -
bankAddressCityLocalitystring nullableCity or locality of bank's address -
bankAddressStateProvincestring nullableState or province of bank's address -
bankAddressPostalCodestring nullablePostal code of bank's address -
bankAddressCountryCodestring nullableTwo-letter ISO country code of bank's address, should equal shortCountryCode -
ownerobjectDEPRECATED - Use ownerName and normalized address fields insteadowner object
-
namestring deprecatedDEPRECATED - Use ownerName instead -
address1object deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2object deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3object deprecatedDEPRECATED - Use additional normalized address fields instead
-
-
addressstring deprecatedDEPRECATED - Use normalized bank address fields instead -
ownerAddressstring deprecatedDEPRECATED - Use normalized owner address fields instead -
address1string deprecatedDEPRECATED - Use ownerAddressLine1 instead -
address2string deprecatedDEPRECATED - Use ownerAddressLine2 instead -
address3string deprecatedDEPRECATED - Use additional normalized address fields instead
400
Bad Request
Response Body
object
-
errorNamestring required -
errorstring required
401
Unauthorized
Response Body
object
-
errorNamestring required -
errorstring required
403
Forbidden
Response Body
object
-
errorNamestring required -
errorstring required
404
Not Found
Response Body
object
-
errorNamestring required -
errorstring required
500
Internal Server Error
Response Body
object
-
errorNamestring required -
errorstring required