List bank ACH/Wire requests with filters

get

https://wealth-rest-api.softwarealgo.com/v1/bankrequest/list

Retrieves a list of ACH and Wire transfer requests. Supports filtering by status, date range, transfer type, account, and other criteria.

⚠️ Important Notes

If a non-zero requestId is provided, all other filters will be ignored. The query will return only the transfer request matching the specified ID.
If isOpen is set to true, date range and externalId filter will be ignored.
If an externalId is provided, date range and isOpen filter will be ignored.
Else, if none of the above override filters are set, both fromDate and toDate must be provided to define the query range.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

requestId

int64

Bank request numeric unique identifier generated by the system. When a non-zero Request ID is provided, all other filters will be disregarded. The query will return only the transfer request matching the specified ID.

isOpen

boolean

If set to true, filters transfer requests whose status is not one of the following: 'Sent', 'Denied', 'Canceled', or 'Bank Rejected'. This includes requests that are still open and may be eligible for further processing or modification. If set to true, all other filters will be disregarded.

dateType

string

Filter based on type of dates. The default value is System Date Check /v1/systemcode/list API for valid values (type = 'Date Type ACH'), use the 'code' value. This filter will be ignored if 'Is Open' filter is set to true or 'Request Id' is not zero.

fromDate.year

int32

Year of date. Must be from 1 to 9999, or 0 if specifying a date without
a year.

fromDate.month

int32

Month of year. Must be from 1 to 12, or 0 if specifying a year without a
month and day.

fromDate.day

int32

Day of month. Must be from 1 to 31 and valid for the year and month, or 0
if specifying a year by itself or a year and month where the day is not
significant.

toDate.year

int32

Year of date. Must be from 1 to 9999, or 0 if specifying a date without
a year.

toDate.month

int32

Month of year. Must be from 1 to 12, or 0 if specifying a year without a
month and day.

toDate.day

int32

Day of month. Must be from 1 to 31 and valid for the year and month, or 0
if specifying a year by itself or a year and month where the day is not
significant.

branch

string

A branch office is a location, other than the main office, where a business is conducted. Most branch offices consist of smaller divisions of different aspects of the firm.

rep

string

A registered representative (RR) is a person who works for a client-facing financial firm such as a brokerage company and serves as a representative for clients who are trading investment products and securities. Registered representatives may be employed as brokers, financial advisors, or portfolio managers.

masterAccountNo

string

Master or roll-up account. Alphanumeric master account number which can be used across the system.

correspondent

string

The name given to a bank, broker, dealer, or financial institution that acts on behalf of another financial institution. Four Alpha numeric character.

accountNo

string

The alphanumeric identifier of the account.

transferType

string

Indicates the direction of the fund movement. Check /v1/systemcode/list API (type = 'Type', subType = 'Transfer Type') for possible values.

requestType

string

Specifies the type of fund transfer request. Check /v1/systemcode/list API (type = 'Type', subType = 'Request Type') for possible values.

status

string

Represents the current state of the transfer request. Check /v1/systemcode/list API (type = 'Status', subType = 'Bank Request') for possible values.

externalId

string

An identifier that is related to the account holder outside the system. When external ID is provided, all other filters will be disregarded.

sign

string

Defines the comparison operator used to filter transfer amounts. This field determines how the specified amount will be matched against transfer records. Check /v1/systemcode/list API (type = 'Sign', subType = 'Request Type') for possible values.

amount

string

Specifies the monetary amount involved in the transfer request. The value will be ignored if an invalid 'sign' is set.

pagination.pageSize

int64

Number of records to return per page. Used to control the size of each paginated response.

pagination.pageNo

int64

Zero-based index of the page to retrieve. For example, page_no = 0 returns the first page.

pagination.sortName

string

Name of the field to sort by. Leave empty for default sorting behavior.

pagination.sortDirection

string

Sorting order for the results. Acceptable values are 'asc' for ascending and 'desc' for descending.

pagination.filterNames

array of strings

List of field names to apply filters on. Must correspond to valid queryable fields.

pagination.filterNames

pagination.filterValues

array of strings

List of values corresponding to each filter name. The position of each value must match the position of its filter name.

pagination.filterValues

Response

200A successful response.