swagger: '2.0'
info:
  title: ATM Locator
  x-ibm-name: atm-locator
  version: 1.0.10
  description: The Citizens Bank ATM Locator API enables users to locate all Citizens Bank ATMs throughout
    the USA. Using Zip Code, Street Address or longitudinal and latitudinal data, users can find the location
    of the ATM, the hours of operation and the whether the location is a standalone ATM or part of another
    entity (e.g. Supermarket).
  x-ibm-summary: ''
  x-source-url: https://sandboxdeveloper.citizensbank.com/product/127/api/103
  x-harvested: '2026-09-05'
  x-harvest-method: searched
  x-environment: sandbox
schemes:
- https
basePath: /v1/atm-locator
produces:
- application/json
consumes:
- application/json
security:
- Partner Id:
  - email
securityDefinitions:
  Partner Id:
    type: apiKey
    description: Used for differentiating the registered vendors/partners
    name: Partner-ID
    in: header
    x-key-type: client_id
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
  cors:
    enabled: true
  type: rest
  application-authentication:
    certificate: false
  servers:
  - url: https://sandboxapi.citizensbank.com/v1/atm-locator
    type:
    - production
    - development
definitions:
  Address:
    type: object
    properties:
      line1:
        type: string
      city:
        type: string
      Warwick:
        type: string
      state:
        type: string
      postalCode:
        type: string
      country:
        type: string
  Atm:
    type: object
    properties:
      features:
        type: array
        items:
          type: string
  AtmsDetails:
    type: object
    properties:
      locationNumber:
        type: string
      locationName:
        type: string
      phoneNumber:
        type: string
      latitude:
        type: integer
        format: int32
      longitude:
        type: integer
        format: int32
      cashDenomination:
        type: string
      routingNumber:
        type: string
      address:
        $ref: '#/definitions/Address'
      atm:
        $ref: '#/definitions/Atm'
  GetLocationsResponse:
    type: object
    properties:
      locationDetails:
        type: array
        items:
          $ref: '#/definitions/AtmsDetails'
      error:
        $ref: '#/definitions/LocationError'
      numberOfLocations:
        type: integer
        format: int32
  LocationError:
    type: object
    properties:
      errorMessage:
        type: string
      errorNumber:
        type: string
  Brand:
    type: object
    properties:
      BrandName:
        type: string
      ATM:
        type: array
        items:
          $ref: '#/definitions/Atm'
      brandName:
        type: string
      atm:
        type: array
        items:
          $ref: '#/definitions/Atm'
  SearchByPostalResponse:
    type: object
    properties:
      data:
        type: array
        items:
          $ref: '#/definitions/SearchByPostalResponseData'
  SearchByPostalResponseData:
    type: object
    properties:
      brand:
        type: array
        items:
          $ref: '#/definitions/Brand'
paths:
  /latitude/\{latitude}/longitude/{longitude}:
    parameters:
    - name: latitude
      in: path
      required: true
      description: input latitude value
      type: string
    - name: longitude
      in: path
      required: true
      description: input longitude value
      type: string
    get:
      responses:
        '200':
          schema:
            type: string
          description: success
  /state/{state}/city/{city}:
    parameters:
    - name: state
      in: path
      required: true
      description: Input state code
      type: string
    - name: city
      in: path
      required: true
      description: Input city code
      type: string
    get:
      responses:
        '200':
          schema:
            type: string
          description: success
  /postalcode/{postalCode}:
    get:
      summary: findAtmsByPostalCode
      x-swagger-router-controller: atm-controller
      description: ''
      operationId: findAtmsByPostalCode
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: postalCode
        description: To get atm information
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SearchByPostalResponse'
host: sandboxapi.citizensbank.com