right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (592 APIs)

API Host: https://obp-apisandbox.joinfincubator.com
Bank
Accounts
Views
Counterparties
Transactions

Get Atms

Get list of atms

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://obp-apisandbox.joinfincubator.com/obp/v5.1.0/banks/obp1/atms"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
[{
  "atmId":"1",
  "atmType":"Enum",
  "atmInfo":{
    "name":{
      "arName":"asd",
      "enName":"ASD"
    },
    "address":{
      "addressLines":{
        "line1":"1",
        "line2":"2",
        "line3":"3"
      },
      "city":"Amman",
      "state":"Amman",
      "postCode":"xxx000",
      "countryInfo":{
        "countryCode":"JO",
        "countryName":"Jordan"
      },
      "location":{
        "latitude":0,
        "longitude":0
      },
      "moreInfo":"short walk to the lake from here"
    },
    "institutionBasicInfo":{
      "institutionType":"BANK",
      "institutionIdentification":{
        "schema":"BIC",
        "code":"BIC"
      },
      "name":{
        "enName":"BIC_CODE",
        "arName":"XXXXJOAX",
        "enTradeName":"",
        "arTradeName":""
      },
      "institutionPhoneNumber":"+381631954907"
    },
    "branchBasicInfo":{
      "branchIdentification":{
        "schema":"BIC",
        "code":"BIC"
      },
      "name":{
        "enName":"string",
        "arName":"testtest"
      },
      "branchPhoneNumber":"+381631954907"
    }
  },
  "access24HoursIndicator":true,
  "workingHours":{
    "sunday":{
      "isWorkingDay":true,
      "openingTime":"10:00",
      "closingTime":"18:00",
      "secondOpeningTime":"19:00",
      "secondClosingTime":"23:00"
    },
    "monday":{
      "isWorkingDay":true,
      "openingTime":"10:00",
      "closingTime":"23:00"
    },
    "tuesday":{
      "isWorkingDay":true,
      "openingTime":"10:00",
      "closingTime":"18:00",
      "secondOpeningTime":"19:00",
      "secondClosingTime":"23:00"
    },
    "wednesday":{
      "isWorkingDay":true,
      "openingTime":"10:00",
      "closingTime":"18:00",
      "secondOpeningTime":"19:00",
      "secondClosingTime":"23:00"
    },
    "thursday":{
      
    },
    "friday":{
      
    },
    "saturday":{
      
    }
  },
  "isAvailable":true,
  "hasAccessiblityFeatures":true,
  "accessibilityFeatures":["wheelchairSupported"],
  "hasDepositCapability":true,
  "languages":[{
    "languageCode":"CCC",
    "languageDesc":"asd"
  }],
  "services":["cashOut"],
  "currencies":["JOD"],
  "notes":["test"],
  "minwithdrawal":{
    "currency":"JOD",
    "amount":5
  },
  "maxwithdrawal":{
    "currency":"JOD",
    "amount":5000
  },
  "defaultFeeSurcharges":{
    "defaultCashWithdrawalNationalFee":{
      "currency":"JOD",
      "amount":1
    },
    "defaultCashWithdrawalInternationalFee":{
      "currency":"JOD",
      "amount":1
    },
    "defaultBalanceInquiryFee":{
      "currency":"JOD",
      "amount":"0.2"
    }
  },
  "routings":[{
    "scheme":"CLIQ",
    "address":"RAFBJOAXAXXX"
  }],
  "_links":{
    "self":{
      "href":"institution/{institutionType}/{code}/ATM/{atmId}"
    },
    "institution":{
      "href":"institution/{institutionType}/{code}"
    }
  }
}]
Required Roles:
  • CanGetDynamicEndpoint_Atms464 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_atms, operation_id: OBPv4.0.0-dynamicEndpoint_GET_atms Tags: JOPACC ATM TEST service, Dynamic-Endpoint, Dynamic,