Linked Bank Accounts

Retrieve Linked Bank Account

Retrieves a Linked Bank Account by bankAccountID.

get/bank-accounts/{bankAccountID}

Request

Base URL
https://bo-api.drivewealth.io/back-office
URL
https://bo-api.drivewealth.io/back-office/bank-accounts/{bankAccountID}
Auth
HTTP bearer

Path parameters

bankAccountIDstring required

The unique DriveWealth identifier that identifies each linked bank account.

Example:bank_123e4567-e89b-12d3-a456-00000000004a

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_123e4567-e89b-12d3-a456-00000000004a",
  "userDetails": {
    "userID": "123e4567-e89b-12d3-a456-000000000004",
    "username": "ttc.user.john",
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.doe@example.com",
    "parentIB": {
      "id": "123e4567-e89b-12d3-a456-000000000005",
      "name": "Tendies Trading Company"
    },
    "wlpID": "TTC",
    "walletSettlementProfileID": "bank-profile-1"
  },
  "bankAccountDetails": {
    "bankAccountNumber": "****3174",
    "bankRoutingNumber": "123456789",
    "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": "John Doe",
    "accountHolderAddress": "123 Main Street, New York, NY, 10001",
    "accountHolderCountry": "USA"
  },
  "default": true,
  "status": "ACTIVE",
  "created": "2022-12-11T22:28:21.810Z",
  "updated": "2022-12-11T22:28:21.810Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.