Details

openapi: 3.0.0 info: version: 1.0.0 title: Institution Routing Info tags: - name: Routing Numbers description: General names for institutions from routing numbers - name: Fed Info description: Information involving ACH/Wire enabled institutions from the Fed. servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname paths: '/institutions/routing-numbers/{routingNumbers}': get: tags: - Routing Numbers description: Get institution names from a comma-separated list of routing numbers. parameters: - in: path name: routingNumbers description: Comma-separated list of routing numbers required: true schema: type: string example: "102301199,103113153" responses: "200": description: OK content: application/json: schema: "$ref": "#/components/schemas/InstitutionRoutingNumbersResponse" '/fedinfo/{routingNumber}/ach': get: tags: - Fed Info description: Get information about ACH abilities from the Fed. parameters: - in: path name: routingNumber description: Routing Number required: true schema: "$ref": "#/components/schemas/RoutingNumber" responses: "200": description: OK content: application/json: schema: "$ref": "#/components/schemas/FedACHInfo" "404": description: Not found, or not documented by fed as eligable for ACH. '/fedinfo/ach/search': get: tags: - Fed Info description: Search information about ACH abilities from the Fed. parameters: - in: query name: query description: User input for searching. Will search on routing number, institution name, city, address, state, zip code. required: true schema: type: string - in: query name: limit description: Maximum number of records to return. required: true schema: type: number responses: "200": description: OK. Can return empty array if no search results are found. content: application/json: schema: type: array items: "$ref": "#/components/schemas/FedACHInfo" '/fedinfo/{routingNumber}/wires': get: tags: - Fed Info description: Get information about Wires abilities from the fed parameters: - in: path name: routingNumber description: Routing Number required: true schema: "$ref": "#/components/schemas/RoutingNumber" responses: "200": description: OK content: application/json: schema: "$ref": "#/components/schemas/FedWireInfo" "404": description: Not found, or not documented by fed as eligable for wires. '/fedinfo/wires/search': get: tags: - Fed Info description: Search information about wires abilities from the fed parameters: - in: query name: query description: User input for searching. Will search on routing number, institution name, city, or state state. required: true schema: type: string - in: query name: limit description: Maximum number of records to return. required: true schema: type: number responses: "200": description: OK. Can return empty array if no search results are found. content: application/json: schema: type: array items: "$ref": "#/components/schemas/FedWireInfo" components: schemas: RoutingNumber: type: object description: A 9 digit, federally issued identifier from the Federal reserve for a financial institution. properties: routingNumber: type: string InstitutionRoutingNumber: type: object properties: routingNumber: type: string institutionName: type: string InstitutionRoutingNumbersResponse: type: object properties: routingNumbers: type: array items: "$ref": "#/components/schemas/InstitutionRoutingNumber" FedWireInfo: type: object properties: routingNumber: type: string description: A routing number for a FI. Routing numbers can have leading zeros and are always 9 digits long. example: 082900432 telegraphicName: type: string description: A short name for a FI, often used for transfers. example: HOMETOWN CNB institutionName: type: string description: The name of the FI. example: HOMETOWN BANK state: type: string description: Two letter code where the FI primarily resides. example: MO city: type: string description: Name of the city where the FI primarily resides. fundsEligibility: type: boolean description: True if the FI can recieve wires, false if not. updatedAt: type: string description: Last time we got information updated from the fed about this FI. example: '2021-03-17T09:18:07.368Z' FedACHInfo: type: object properties: routingNumber: type: string description: A routing number for a FI. Routing numbers can have leading zeros and are always 9 digits long. example: 082900432 institutionName: type: string description: Name of the FI. example: Simmons Bank address: type: string description: Address of the FI, most often the HQ of the FI. example: 500 ROSS ST. city: type: string description: FI's main city of presence. state: type: string description: FI's state of presence. Two letter short code. example: PA zip: type: string description: FI's main zip code of presence. zipExt: type: string description: FI's extended zip code. phone: type: string description: Phone number of the FI. example: 417-417-8324 updatedAt: type: string description: Last time we got information updated from the fed about this FI. example: '2021-03-17T09:18:07.368Z'