Getting Started Guides
Create a new internal Financial Account to manage funds and track account balances for a Customer. The account must be linked to another Financial Account, which is called the “parent account”.
The Financial Account is classified as an “internal Financial Account” to indicate that it exists within RocketKOR and is not linked to an account at an external financial institution. This means that internal Financial Accounts cannot be used for transactions outside of RocketKOR, such as deposits and withdrawals.
In this guide, you’ll learn how to:
Sandbox Account: Sign up for a RocketKOR sandbox account. When your sandbox account is created, one or more Service Accounts will be created for your Business Account. A Service Account is a non-human user of a Business Account that performs functions (such as creating transactions) via the RocketKOR APIs on behalf of the Business Account.
Authentication: Before you can call the APIs, you must authenticate a Service Account by exchanging the account’s API key and secret for an access token.
Customer Account: Ensure the Business Customer or Individual Customer has an active Customer Account.
Use the Identity Verification solution to verify the Customer Account. For details, see Get Started: Verify a Customer (IDV).
Create an internal Financial Account for the Customer. At a minimum, the request must include the following information:
|
Parameter |
Description |
|---|---|
|
name |
Name for the Financial Account. |
|
parentId |
ID of the Parent Financial Account. |
|
accountHolderId |
Customer Account ID. |
|
accountHolderType |
Type of entity referenced by accountHolderId. Value must be CUSTOMER. |
POST /v1/internal-financial-accounts
{
"name": "ABC Internal Account",
"parentId": "4563ee45-446e-4c6e-83d8-2d5767614a5",
"accountHolderId": "91365a4a-c040-4c37-bb8a-50f46edde48b",
"accountHolderType": "CUSTOMER"
}
Returns the Internal Financial Account object.
Make a note of the Financial Account id. You’ll need this ID in the next step when you retrieve the Financial Account.
{
"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",
"accountHolderId": "91365a4a-c040-4c37-bb8a-50f46edde48b",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
...
}
Retrieve the Financial Account that you created in the previous step.
GET /v1/financial-accounts/{financialAccountId}
In the request, pass the Financial Account id from step 2 to the financialAccountId parameter.
Returns the Internal Financial Account object.
{
"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",
"accountHolderId": "91365a4a-c040-4c37-bb8a-50f46edde48b",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
...
}
The Financial Account can now be used in Push-to-Card, ACH, and Wire transactions.
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.
