The Bank Accounts API allows managing taxpayer-linked refund deposit accounts. It provides endpoints to create, retrieve, update, and delete bank account records used for refund disbursement.
For general API authentication, headers, and response formats, refer to the API Main Page.
Retrieves a single bank account by its unique identifier.
Endpoint:
GET /trbs/api/v1/bankaccounts/{id}
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Yes | Unique identifier of the bank account. |
| Header | Type | Required | Description |
|---|---|---|---|
Authorization |
string | Yes | Bearer token. |
Content-Type |
string | Yes | Must be application/json. |
{
"statusCode": 200,
"statusDescription": "Bank Account retrieved successfully.",
"responseId": "d4f9b8c2-1234-4abc-9def-456789abcdef",
"data": {
"bankAccountId": 1001,
"taxPayerId": 3001,
"bankId": 201,
"routingNumber": "123456789",
"accountNumber": "****6789",
"firstName": "John",
"middleInitial": "A",
"lastName": "Doe",
"options": 0
"status": 0,
"fraudStatus": 0,
"createdById": 101,
"createdDate": "2024-12-01T10:00:00Z",
"lastChangedById": 102,
"lastChangedDate": "2024-12-15T14:30:00Z",
"options": 0
}
}
Creates a new bank account record.
Endpoint:
POST /trbs/api/v1/bankaccounts
| Field | Type | Required | Description |
|---|---|---|---|
taxYear |
integer | Yes | Tax year for the refund. |
ssn |
string | Yes | Tax Payer’s Social Security Number. Use no dashes |
dob |
string | Yes | Tax Payer’s Social Date of Birth. Format: YYYYMMDD |
efin |
string | Yes | Office’s EFIN number filing the return. |
firstName |
string | Yes | Tax Payer’s First Name. |
middleInitial |
string | No | Tax Payer’s Middle Initial. |
lastName |
string | Yes | Tax Payer’s Last Name. |
addressLine1 |
string | Yes | Tax Payer’s Address Line 1. |
addressLine2 |
string | No | Tax Payer’s Address Line 2. |
city |
string | Yes | Tax Payer’s City. |
state |
string | Yes | Tax Payer’s State, two letter code. |
zipCode |
integer | Yes | Tax Payer’s Zip Code number (9 or 5 digits). |
emailAddress |
string | Yes | Tax Payer’s Email Address. |
phoneNumber |
string | Yes | Tax Payer’s Phone Number. Use no dashes. |
options |
integer | No | Account options. |
{
"taxYear": 2025,
"ssn": "123456789",
"dob": "19850715",
"efin": "001234",
"firstName": "John",
"middleInitial": "A",
"lastName": "Doe",
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "Springfield",
"state": "NY",
"zipCode": 12345,
"emailAddress": "[email protected]",
"phoneNumber": "5551234567",
"options": 0
}
{
"statusCode": 201,
"statusDescription": "Bank Account successfully created.",
"responseId": "789abcde-0123-4567-89ab-123456abcdef",
"data": {
"bankAccountId": 1010,
"accountNumber": "987654321098",
"routingNumber": "123456789",
"accountStatus": "Active",
"status": 0,
}
}
This section outlines the various enumerated types used in the Bank Accounts API. These enums define the values for certain fields such as account status. Use this section to interpret or set valid values for these fields in requests or responses.
Represents configurable flags that modify behavior or state of a bank account. This is a bitwise field allowing multiple options to be combined using integer values.
| Value | Flag Name | Description |
|---|---|---|
| 0 | Undefined |
No options applied. |
Defines the operational state of a bank account. This status may affect account visibility, activity, and behavior in workflows.
| Value | Name | Description |
|---|---|---|
| 0 | Normal | Default state. |
| 1 | Inactive | Not in use. |
| 2 | Hidden | Hidden from user views. |
| 4 | Deleted | Marked as deleted. |
| 8 | Archived | Archived from active usage. |
| 16 | System | System-reserved record. |
| 32 | Generated | Auto-generated by system. |
| 64 | Confirmed | Generated and later confirmed. |
| 128 | Void | Voided account. |
| 256 | MarkForDelete | Scheduled for deletion. |
| 512 | Draft | Draft account, not finalized. |
Represents the business-level status of the bank account. While status may be system-controlled, this field tracks whether an account is in good standing or restricted for business operations.
| Value | Name | Description |
|---|---|---|
| 0 | Undefined | No status set. |
| 1 | Suspended | Temporarily blocked from activity. |
| 2 | UnderReview | Account is undergoing compliance or fraud review. |
| 4 | Closed | Account is permanently closed and cannot be reused. |
| 8 | Pending | Awaiting verification or activation. |
| 16 | Rejected | Verification failed, account was not approved for use. |
Indicates the current fraud validation status of the bank account. This enum helps identify if a bank account is under fraud investigation or has been cleared or confirmed as fraudulent.
| Value | Name | Description |
|---|---|---|
| 0 | Undefined | Default state. No fraud status assigned. |
| 1 | Flagged | Flagged for potential fraud. |
| 2 | Reviewing | Under active fraud review. |
| 4 | Cleared | Cleared of fraud suspicion. |
| 8 | Escalated | Escalated for further investigation. |
| 16 | Locked | Locked due to fraud concerns. |
| 32 | FalsePositive | Determined to be a false alarm. |
| 64 | Confirmed | Fraud confirmed. |
| 128 | Reported | Reported to external authorities. |