Create Bank Account
Use the Create Bank Account API endpoint to create a new bank account and associate it with a customer.
ImportantCertain Credit API endpoints are in a draft status and are subject to change without notice. Thredd may modify interfaces, behaviour, and documentation as development continues.
The Create Bank Account endpoint enables you to register a new bank account and link it to a customer's profile in the system. Once created, the bank account can be used to make payments against the customer's line of credit.
More InformationFor more information about the Bank Account endpoints, see: Bank Accounts.
Prerequisites
To integrate calls to the Create Bank Account endpoint, you need:
- The
customer_idof the customer to associate the bank account with. This is the Thredd Account Holder ID, returned when a credit application is approved. - The customer's bank account details, including account number, routing number, and account type.
- A unique account title for this bank account. The title must not already be in use by another bank account associated with this customer.
Example Request
Create a bank account by making a POST request to the Create Bank Account endpoint.
POST {{baseUrl}}/api/v1/credit/bank-account/customer/{customer_id}
Path Parameters
| Parameter | Description |
|---|---|
customer_id | string. Required. The unique identifier of the customer (Thredd Account Holder ID). |
Example Payload
{
"accountNumber": "string",
"accountTitle": "string",
"routingNumber": "string",
"accountType": "checking | savings"
}{
"accountNumber": "123456789",
"accountTitle": "Jane's Checking",
"routingNumber": "021000021",
"accountType": "checking"
}Request Fields
| Attribute | Description |
|---|---|
accountNumber | string. Required. The bank account number. |
accountTitle | string. Required. The title of the bank account. Must be unique among all bank accounts associated with this customer. |
routingNumber | string. Required. The routing number of the bank. Must be exactly nine numeric digits. |
accountType | string. Required. The type of bank account. Possible values: checking, savings. |
Example Response
A successful request returns a 200 HTTP status code with the unique identifier of the newly created bank account.
NoteIf the request contains invalid data or is incomplete, the system returns a
422HTTP error and details of the validation failure.
{
"bankAccountId": "ba_123456"
}{
"detail": "Duplicate checking account was found associated to this customer."
}{
"detail": "Customer mapping not found."
}{
"detail": "Bank account created, but failed to associate with customer profile in LoanPro."
}{
"detail": [
{
"loc": ["body", "routingNumber"],
"msg": "Field required",
"type": "missing"
}
]
}Response Fields
| Attribute | Description |
|---|---|
bankAccountId | string. The unique identifier of the bank account that was created. |
Error Messages
If there is a problem with the request, the response returns one of the following errors:
400— A duplicate account of the same type already exists for this customer.404— The customer ID provided does not match an existing customer.424— The bank account was created, but could not be associated with the customer's profile in the loan management system.422— A required field or its value is missing or invalid. The response includes details of the validation failure.
Updated 7 days ago
