Getting Started Guides
Create a new Financial Account for a Customer’s existing bank account at a financial institution.
This type of Financial Account is called an “external Financial Account” because it is linked to an account at an external financial institution.
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 external Financial Account for the Customer’s bank account. At a minimum, the request must include the following information:
|
Parameter |
Description |
|---|---|
|
name |
Name for the Financial Account. |
|
accountHolderId |
Customer Account ID. |
|
accountHolderType |
Type of entity referenced by accountHolderId. Value must be CUSTOMER. |
|
subtype |
Type of bank account (CHECKING, SAVING). |
|
bankAccount |
Details for the Customer’s bank account. Includes bankName, routingNo and accountNumber. If the Financial Account will be used for wire transactions, billingAddress is also required. |
POST /v1/external-bank-accounts
{
"name": "Checking",
"accountHolderId": "91365a4a-c040-4c37-bb8a-50f46edde48b",
"accountHolderType": "CUSTOMER",
"subtype": "CHECKING",
"bankAccount": {
"bankName": "Citibank",
"routingNo": "321171184",
"accountNumber": "89674523",
"billingAddress": {
"addressLine1": "625 Queen St",
"city": "Vancouver",
"state": "BC",
"country": "CAN",
"postalCode": "V5K 0A1"
}
}
}
Returns the External Bank 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": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"businessAccountId": "a1d8b427-d2b2-4711-bc10-f515366bb8d6",
"name": "Checking",
"category": "EXTERNAL",
"type": "BANK",
"subtype": "CHECKING",
"accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
"bankAccount": {
"bankName": "Citibank",
"routingNo": "321171184",
"accountNumber": "89674523",
"billingAddress": {
"addressLine1": "625 Queen St",
"city": "Vancouver",
"state": "BC",
"country": "CAN",
"postalCode": "V5K 0A1"
}
},
...
}
Retrieve the Financial Account that you created in the previous step.
GET /v1/financial-accounts/{financialAccountId}
In the request, pass the Financial Account id to the financialAccountId parameter.
Returns the External Bank Financial Account object.
{
"id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"businessAccountId": "a1d8b427-d2b2-4711-bc10-f515366bb8d6",
"name": "Checking",
"category": "EXTERNAL",
"type": "BANK",
"subtype": "CHECKING",
"accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
"bankAccount": {
"bankName": "Citibank",
"routingNo": "321171184",
"accountNumber": "89674523",
"billingAddress": {
"addressLine1": "625 Queen St",
"city": "Vancouver",
"state": "BC",
"country": "CAN",
"postalCode": "V5K 0A1"
}
},
...
}
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.
