v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Linked Bank Accounts

Retrieve Linked Bank Account

Retrieves a Linked Bank Account by bankAccountID.

get/bank-accounts/{bankAccountID}

Path parameters

bankAccountIDstring required

The unique DriveWealth identifier that identifies each linked bank account.

Example:bank_a4656e60-321e-425b-aa0d-a2e75c38885f

Response

Retrieving a Linked Bank Account was Successful.

idstring

The unique DriveWealth identifier that identifies each linked bank account.

bankAccountPurpose'TRAVEL_RULE' | 'SETTLEMENT_PROFILE'

The linked account purpose.

defaultboolean

True, if the bank account is the user's default bank account. Only one bank account can be set to true.

status'ACTIVE' | 'DELETED' | 'DISABLED'

The current status of the user's external linked bank account.

createdstring

updatedstring

Example response

{
  "id": "bank_a4656e60-321e-425b-aa0d-a2e75c38885f",
  "userDetails": {
    "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
    "username": "ttc.user.justin",
    "firstName": "Justin",
    "lastName": "Smith",
    "email": "jj@drivewealth.dev",
    "parentIB": {
      "id": "80f9b672-120d-4b73-9cc9-42fb3262c4b9",
      "name": "Tendies Trading Company"
    },
    "wlpID": "TTC",
    "walletSettlementProfileID": "bank-profile-1"
  },
  "bankAccountDetails": {
    "bankAccountNumber": "****3174",
    "bankRoutingNumber": "110000000",
    "bankAccountType": "CHECKING",
    "backAccountNickname": "PREFERRED CHECKING",
    "bankName": "Bank of America",
    "bankAddress": {
      "addressLine1": "222 Broadway, New York City, NY, 10038",
      "country": "USA"
    }
  },
  "bankAccountPurpose": "TRAVEL_RULE",
  "beneficiaryDetails": {
    "accountHolderName": "Justin Smith",
    "accountHolderAddress": "15 Exchange Place, Jersey City, NJ, 07302",
    "accountHolderCountry": "USA"
  },
  "default": true,
  "status": "ACTIVE",
  "created": "2022-12-11T22:28:21.810Z",
  "updated": "2022-12-11T22:28:21.810Z"
}