Banks

The Banks endpoint allows you to programmatically access information about known banks in the US Federal Reserve Bank Network. You can utilize this endpoint for use cases like providing users an auto-complete when entering their bank name, or for checking the validity of a routing number.

Data Types

BankResponse

Key	Value	Notes
type	banks
id	UUID
Attributes
name	String
routing-number	String
phone-number	String
address	BankAddress
created-at	Timestamp
updated-at	Timestamp

BankResponse Example

{
  "data": {
    "type": "banks",
    "id": "4c72784e-fb2a-4858-8067-95b6e36d54c0",
    "attributes": {
      "name": "Bank of America, N.A.",
      "routing-number": "071000013",
      "phone-number": "800-432-1000",
      "address": {
        "street": "111 Peachtree St NE",
        "city": "Atlanta",
        "state": "GA",
        "zipcode": "30345",
        "zipcode-ext": "000"
      },
      "created-at": "2022-06-21T23:34:04Z",
      "updated-at": "2022-06-21T23:34:04Z"
    }
  }
}

GET/v1/banks

List Banks

This endpoint retreives a paginated list of Banks. By default, a maximum of thirty Banks are shown per page.

This endpoint returns an array of BankResponse objects.

Filters

Name
query
Type
string
Description
Filters the list by Banks with a name or routing number that matches the query string.

Name
created_between
Type
object
Description
See documentation for filtering by timestamps.
Name
updated_between
Type
object
Description
See documentation for filtering by timestamps.
Name
metadata
Type
object
Description
See documentation for filtering by metadata.
Name
page
Type
object
Description
See documentation for pagination.

Request

GET

/v1/banks

  curl --request GET \
    --url https://api.opentransact.com/v1/banks \
    --header 'Authorization: Basic {API_KEY}'

Response

{
  "data": [
    {
      "type": "banks",
      "id": "4c72784e-fb2a-4858-8067-95b6e36d54c0",
      "attributes": {
        "name": "Bank of America, N.A.",
        "routing-number": "071000013",
        "phone-number": "800-432-1000",
        "address": {
          "street": "111 Peachtree St NE",
          "city": "Atlanta",
          "state": "GA",
          "zipcode": "30345",
          "zipcode-ext": "0000"
        }
      }
    },
    ... // 29 more Banks
  ],
  "meta": {
    "page-count": 2,
    "count": 38,
    "current-page": 1,
  },
  "links": {
    "self": "https://api.opentransact.com/v1/banks?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "first": "https://api.opentransact.com/v1/banks?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "next": "https://api.opentransact.com/v1/banks?page%5Bnumber%5D=2&page%5Bsize%5D=30",
    "last": "https://api.opentransact.com/v1/banks?page%5Bnumber%5D=2&page%5Bsize%5D=30"
  }
}

GET/v1/banks/:routing_number

Show a Bank

This endpoint retrieves the details of a Bank by providing its routing-number.

This endpoint returns a BankResponse object.

Request

GET

/v1/banks/:routing_number

curl https://api.opentransact.com/v1/banks/071000013 \
  -H "Authorization: Bearer {token}"

Response

{
  "data": {
    "type": "banks",
    "id": "4c72784e-fb2a-4858-8067-95b6e36d54c0",
    "attributes": {
      "name": "Bank of America, N.A.",
      "routing-number": "071000013",
      "phone-number": "800-432-1000",
      "address": {
        "street": "111 Peachtree St NE",
        "city": "Atlanta",
        "state": "GA",
        "zipcode": "30345",
        "zipcode-ext": "0000"
      }
    }
  }
}