I am developing for the

market, looking for the

API Documentation.

Home

>

API Products

>

Mexico - ATM Branch Locator API Documentation

ATM Branch Locator

Summary

The 'ATM and Branch locations' API allows any end user to view the geo-location of a set of places associated with Banamex by providing Address and Radius as input parameters.

The ATM Branch Locator API uses the client_credentials grant type, for authorization details CLICK HERE

Want to try this API out on our Playground?

Go play now
Endpoints on this page
get /v1/bank/facility/locator Retrieve ATM and Branch locations list

Retrieve ATM and Branch locations list

get /v1/bank/facility/locator
Description

Returns list of ATM's and Banamex Branches based on Address and Radius provided. The result will be retuned in the form of array.

Header Parameters
Authorization
string required
accept
string required
uuid
string required
client_id
string required
Content-Type
string required
Query Parameters
requestSize
integer Optional
{
    "minimum": 1,
    "maximum": 20
}
facilityType
string required
{
    "enum": [
        "ATM",
        "BRANCH",
        "BOTH"
    ]
}
radius
integer required
{
    "minimum": 50,
    "maximum": 50000
}
nextStartIndex
string Optional
addressLine2
string Optional
addressLine1
string required
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation
Definitions
  • facility
      • facilityName
        • type : string
        • Facility Name
      • address
        • properties : Array
      • availableTimes
        • type : string
        • Opening Hours
      • phoneNumber
        • type : string
        • Telephone Number
  • nextStartIndex
    • type : string
Example Response for get /v1/bank/facility/locator
{
    "facility": {
        "facilityName": "Citibanamex Cajero Sta Lucia",
        "address": {
            "addressLine1": "Avenida Santa Lucia 810, Olivar del Conde 1a. Sección, Olivar del Conde 1ra Sección, Ciudad de México",
            "addressLine2": "Mexico",
            "longitude": -99.207281,
            "latitude": 19.3723211,
            "placeId": "ChIJvaZROjcA0oURijaTtB0wEzk",
            "photoUrl": "https:\/\/maps.googleapis.com\/maps\/api\/place\/photo?maxwidth=100&photoreference="
        },
        "availableTimes": "",
        "phoneNumber": ""
    },
    "nextStartIndex": "CqQCEQEAADmTwFWl--pj42XeKxEjVurwjc4UB9zFVhOioma5Qjdt9-2-p53ShawLlv4sK1oco8XMXZirAtCOcq6hYu9y83Kqe2Zq0VtJeuMw_bW7eQ5qXZbq03K3kjLWhBrd1MRsXX7i1Wc65T-b8F9lSvuaGg6yxgfE5TqvwwksrvBgfA6GCjnRmxlRKViCidFycOe9zzEpsNfbxtwNjHTgTTRVQs5l_rdzf9HMbv460LSSr8QNTRw2AXQd2bNlPwgf12v2dkDZDTpzWX1raegVYbBxzOP2Pe9ybf7W7HfJtMKG25jvXzrMbbKWfdOfACA_NZMZTLg1aoiIxaD-BJc6udpcQ1ksOhNphB-Mo-vYgnyoqvxrFm7QmUCOjyYLkiamphgGtRIQ4lASJSVlWnNnG0fvhKDkyhoUXzdEairK-VmFnXwjwNlCgV1nF-Y"
}
400

error invalidRequest Missing or invalid request parameters
Definitions
  • errors
Response Schema for get /v1/bank/facility/locator
{
    "properties": {
        "errors": {
            "type": "array",
            "description": "List of one or more errors",
            "items": {
                "properties": {
                    "type": {
                        "type": "string",
                        "enum": [
                            "error",
                            "warn",
                            "invalid",
                            "fatal"
                        ],
                        "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "code": { "type": "string", "description": "Error code which qualifies the error" }, "details": { "type": "string", "description": "Human readable explanation specific to the occurrence of the problem" }, "location": { "type": "string", "description": "The name of the field that resulted in the error" }, "moreInfo": { "type": "string", "description": "URI to human readable documentation of the error" } }, "required": [ "type", "code" ] } } } }
401

TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • errors
Response Schema for get /v1/bank/facility/locator
{
    "properties": {
        "errors": {
            "type": "array",
            "description": "List of one or more errors",
            "items": {
                "properties": {
                    "type": {
                        "type": "string",
                        "enum": [
                            "error",
                            "warn",
                            "invalid",
                            "fatal"
                        ],
                        "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "code": { "type": "string", "description": "Error code which qualifies the error" }, "details": { "type": "string", "description": "Human readable explanation specific to the occurrence of the problem" }, "location": { "type": "string", "description": "The name of the field that resulted in the error" }, "moreInfo": { "type": "string", "description": "URI to human readable documentation of the error" } }, "required": [ "type", "code" ] } } } }
404

Type Code Details
error resourceNotFound Resource not found
error invalidCustomerId Invalid customerId
Definitions
  • errors
Response Schema for get /v1/bank/facility/locator
{
    "properties": {
        "errors": {
            "type": "array",
            "description": "List of one or more errors",
            "items": {
                "properties": {
                    "type": {
                        "type": "string",
                        "enum": [
                            "error",
                            "warn",
                            "invalid",
                            "fatal"
                        ],
                        "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "code": { "type": "string", "description": "Error code which qualifies the error" }, "details": { "type": "string", "description": "Human readable explanation specific to the occurrence of the problem" }, "location": { "type": "string", "description": "The name of the field that resulted in the error" }, "moreInfo": { "type": "string", "description": "URI to human readable documentation of the error" } }, "required": [ "type", "code" ] } } } }
500

Type Code Details
fatal serverError The server is unable to fulfill the request at this time.
Definitions
  • errors
Response Schema for get /v1/bank/facility/locator
{
    "properties": {
        "errors": {
            "type": "array",
            "description": "List of one or more errors",
            "items": {
                "properties": {
                    "type": {
                        "type": "string",
                        "enum": [
                            "error",
                            "warn",
                            "invalid",
                            "fatal"
                        ],
                        "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "code": { "type": "string", "description": "Error code which qualifies the error" }, "details": { "type": "string", "description": "Human readable explanation specific to the occurrence of the problem" }, "location": { "type": "string", "description": "The name of the field that resulted in the error" }, "moreInfo": { "type": "string", "description": "URI to human readable documentation of the error" } }, "required": [ "type", "code" ] } } } }