Retrieve details for a Financial Account. You can also request the following subresources for the Financial Account: account holder details (for accounts owned by Customers and Recipients), balances, and transaction limits.
Authorization: Bearer <access_token>
financialAccountId REQUIRED
string (UUID)
ID of the Financial Account.
embed
string, values: accountHolder, balances, limits
Specify subresources to embed in the response. The subresources are returned in the _embedded object. The following subresources can be requested:
Use a comma-separated list to return multiple subresources (example: balance,accountHolder,limits).
None
Returns the Financial Account details. One of the following objects is returned:
The _embedded object contains any requested subresources, including:
SAMPLE RESPONSE
{
"id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"businessAccountId": "c937109c-6077-4b4e-8d28-c6768e3546c5",
"name": "Debit Card",
"defaultFlag": true,
"state": "ACTIVE",
"currency": "USD",
"category": "EXTERNAL",
"type": "CARD",
"subtype": "DEBIT",
"maskedAccountNumber": "******4242",
"accountHolderId": "170f5eb0-c318-465d-a365-153941ac55ff",
"accountHolderType": "CUSTOMER",
"createdAt": "2021-07-08T21:10:51.610Z",
"updatedAt": "2021-07-08T21:10:51.610Z",
"card": {
"firstName": "Jack",
"middleName": "Fred",
"lastName": "Smith",
"cardNumberTail": "5791",
"expiry": "2026-10",
"billingAddress": {
"addressLine1": "980 Main St",
"addressLine2": "",
"addressLine3": "",
"city": "Vancouver",
"stateCode": "BC",
"countryCode": "CAN",
"postalCode": "V5K 0A1"
}
},
"_embedded": {
"customer": {
"id": "170f5eb0-c318-465d-a365-153941ac55ff",
"status": "ACTIVE",
"shippingContact": {
"shipToFirstName": "Jack",
"shipToMiddleName": "Fred",
"shipToLastName": "Smith"
},
"metadata": {
"customerRefId": "100000333"
},
"createdBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "EMPLOYEE"
},
"createdAt": "2022-11-23T00:42:50.311Z",
"updatedBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "EMPLOYEE"
},
"updatedAt": "2022-11-23T00:42:50.311Z",
"type": "BUSINESS",
"doingBusinessAsName": "ACME Corp.",
"contacts": [
{
"firstName": "Jack",
"middleName": "Fred",
"lastName": "Smith",
"primary": true,
"primaryPhoneNumber": {
"number": "+14151234",
"type": "WORK",
"provider": "ABC",
"extension": "675",
"verified": false
},
"primaryEmail": {
"value": "jsmith@acme.com",
"verified": false
}
}
]
},
"balances": {
"USD": {
"accountBalance": "1000.00",
"availableBalance": "800.00",
"pendingWithdrawals": "200.00",
"pendingDeposits": "300.00"
}
"CAD": {
"accountBalance": "700.00",
"availableBalance": "600.00",
"pendingWithdrawals": "100.00",
"pendingDeposits": "900.00"
}
},
"limits": {
"financialAccountId": "a1a8cc33-c1a6-4b11-beb9-6809d194f179",
"periods": [
{
"type": "daily",
"from": "2022-06-22T00:00:00+00:00",
"to": "2022-06-23T00:00:00+00:00",
"amount": {
"USD": {
"limit": "10000.00",
"used": "150.00"
},
"CAD": {
"limit": "15000.00",
"used": "350.00"
}
}
},
{
"type": "weekly",
"from": "2022-06-19",
"to": "2022-06-25",
"amount": {
"USD": {
"limit": "50000.00",
"used": "2150.00"
},
"CAD": {
"limit": "65000.00",
"used": "550.00"
}
}
},
{
"type": "monthly",
"from": "2022-06-01T00:00:00+00:00",
"to": "2022-07-01T00:00:00+00:00",
"amount": {
"USD": {
"limit": "200000.00",
"used": "20150.00"
},
"CAD": {
"limit": "265000.00",
"used": "17550.00"
}
}
}
]
}
}
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.