Retrieve all Financial Accounts for a Business Account. This includes Financial Accounts owned by the Business Account, as well as Customer Financial Accounts and Recipient Financial Accounts within the Business Account.
Note Financial Accounts will be retrieved for the Business Account associated with the request access token.
You can filter the results based on criteria such as account holder ID, account holder type, account category, and account name. You can also sort the results and limit the number of results returned.
Authorization: Bearer <access_token>
accountHolderTypes
string, values: BUSINESS_ACCOUNT, CUSTOMER, RECIPIENT
Filter the results by the type of account holder. The following values are supported:
Use a comma-separated list to specify multiple values (example: CUSTOMER,RECIPIENT).
accountHolderId
string (UUID)
Filter the results by a specific account holder. The account holder can be a Business Account, Customer, or Recipient.
categories
string enum, values: EXTERNAL, INTEGRATED, INTERNAL
Filter the results by Financial Account category. The following values are supported:
Use a comma-separated list to specify multiple values (example: INTERNAL,INTEGRATED).
name
string, min length: 1, max length: 100
Filter the results by the Financial Account name. This is an informal name used for the account in RocketKOR.
defaultFlag
boolean
Filter the results based on whether this is the account holder’s default Financial Account.
parentId
string (UUID)
Filter the results based on the ID of the Parent Financial Account.
type
string enum, values: BANK, CARD
Filter the results by the type of Financial Account. The following values are supported:
state
string enum, values: PENDING, ACTIVE, SUSPENDED
Filter the results by the state of the Financial Account. The following values are supported:
cardStartingNumbers
string
This filter is only available for issued cards. Filter the results by the starting numbers for the card. These numbers identify the card BIN and the Program ID.
cardProgramId
string (UUID)
This filter is only available for issued cards. Filter the results by the Card Program ID. This can be useful if multiple Card Programs use the same starting numbers.
cardEndingNumbers
string
This filter is only available for issued cards. Filter the results by the last 4 digits of the card number.
cardExpiry
string, format: yyyy-MM
This filter is only available for issued cards. Filter the results by the card expiry date.
cardInterface
string enum, values: MAGNETIC, EMV
This filter is only available for issued cards. Filter the results by the card interface type. The following values are supported:
fulfillmentHouseId
string
This filter is only available for issued cards. Filter the results by the fulfillment house ID.
shippingMethod
string enum, values: NORMAL, URGENT, VIP, BULK, BULK_URGENT, BULK_VIP
This filter is only available for issued cards. Filter the results by the card shipping method. The following values are supported:
sort
array of strings
Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.
page
integer (int32)
Page number to return, based on zero-based page indexing.
size
integer (int32)
Maximum number of results to return per page.
None
Returns a paginated response with an array of Financial Account objects. The following objects may be returned:
SAMPLE RESPONSE
{
"totalElements": 200,
"totalPages": 50,
"number": 0,
"numberOfElements": 4,
"hasNext": true,
"content": [
{
"id": "6a46f27a-7bbc-4ba8-9e73-45c74139fd81",
"parentId": "4563ee45-446e-4c6e-83d8-2d5767614a5",
"businessAccountId": "2af56dc3-63ff-4e86-ba5b-bf6d184a103c",
"name": "ABC Internal Account",
"category": "INTERNAL",
"type": "BANK",
"subtype": "CHECKING",
"defaultFlag": false,
"currency": "USD",
"accountHolderId": "91365a4a-c040-4c37-bb8a-50f46edde48b",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
"maskedAccountNumber": "******6790",
"createdBy": {
"id": "59dff46b-03d3-449b-89bf-b8010770864f",
"type": "employee"
},
"createdAt": "2024-09-20T22:09:31.947Z",
"updatedBy": {
"id": "59dff46b-03d3-449b-89bf-b8010770864f",
"type": "employee"
},
"updatedAt": "2024-10-20T22:09:31.947Z"
},
{
"id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"businessAccountId": "c937109c-6077-4b4e-8d28-c6768e3546c5",
"name": "Debit Card",
"category": "EXTERNAL",
"type": "CARD",
"subtype": "DEBIT",
"defaultFlag": true,
"currency": "USD",
"accountHolderId": "8c8c5119-3abd-42e8-8b37-f8eaaa4afacb",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
"maskedAccountNumber": "******4242",
"createdBy": {
"id": "59dff46b-03d3-449b-89bf-b8010770864f",
"type": "employee"
},
"createdAt": "2024-09-20T22:09:31.947Z",
"updatedBy": {
"id": "59dff46b-03d3-449b-89bf-b8010770864f",
"type": "employee"
},
"updatedAt": "2024-10-20T22:09:31.947Z",
"card": {
"firstName": "Mark",
"middleName": "David",
"lastName": "Strong",
"cardNumber": "123456784242",
"cardNumberTail": "4242",
"expiry": "2027-12",
"billingAddress": {
"addressLine1": "625 Queen St",
"addressLine2": "Suite 201",
"addressLine3": "South Building",
"city": "Vancouver",
"stateCode": "BC",
"countryCode": "CAN",
"postalCode": "V5K 0A1"
}
}
},
{
"id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"businessAccountId": "a1d8b427-d2b2-4711-bc10-f515366bb8d6",
"name": "Checking",
"category": "EXTERNAL",
"type": "BANK",
"subtype": "CHECKING",
"defaultFlag": true,
"currency": "USD",
"accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
"maskedAccountNumber": "******6790",
"createdBy": {
"id": "59dff46b-03d3-449b-89bf-b8010770864f",
"type": "employee"
},
"createdAt": "2024-09-20T22:09:31.947Z",
"updatedBy": {
"id": "59dff46b-03d3-449b-89bf-b8010770864f",
"type": "employee"
},
"updatedAt": "2024-10-20T22:09:31.947Z",
"bankAccount": {
"bankName": "Citibank",
"routingNo": "321171184",
"accountNumberTail": "4523",
"nameOnAccount": "Mark Strong",
"billingAddress": {
"addressLine1": "625 Queen St",
"addressLine2": "Suite 201",
"addressLine3": "South Building",
"city": "Vancouver",
"stateCode": "BC",
"countryCode": "CAN",
"postalCode": "V5K 0A1"
}
}
},
{
"id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"parentId": "e5f1eb7e-95b5-49c8-80ab-734f988970bc",
"businessAccountId": "a1d8b427-d2b2-4711-bc10-f515366bb8d6",
"name": "Checking",
"category": "INTEGRATED",
"type": "BANK",
"subtype": "CHECKING",
"defaultFlag": true,
"currency": "USD",
"accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
"maskedAccountNumber": "******6790",
"createdBy": {
"id": "59dff46b-03d3-449b-89bf-b8010770864f",
"type": "employee"
},
"createdAt": "2024-09-20T22:09:31.947Z",
"updatedBy": {
"id": "59dff46b-03d3-449b-89bf-b8010770864f",
"type": "employee"
},
"updatedAt": "2024-10-20T22:09:31.947Z",
"bankAccount": {
"bankName": "Citibank",
"routingNo": "321171184",
"accountNumber": "123456784523",
"accountNumberTail": "4523",
"nameOnAccount": "Mark Strong"
}
}
]
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
