API Explorer

AUv1.0.0 (2 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get ATMS

Gets a list of all ATM objects.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "meta":{ "LastUpdated":"2021-05-26T14:49:38.258Z", "TotalResults":0, "Agreement":"To be confirmed", "License":"To be confirmed", "TermsOfUse":"To be confirmed" }, "data":[{ "Brand":[{ "BrandName":"MÉXICO", "ATM":[{ "Identification":"999994090", "SupportedLanguages":["es","en","fr","pt","io"], "ATMServices":["ATBA"], "Accessibility":["ATAC"], "Access24HoursIndicator":true, "SupportedCurrencies":["MXN","USD","GBP"], "MinimumPossibleAmount":"5", "Note":["string"], "OtherAccessibility":[{ "Code":"stri", "Description":"string", "Name":"string" }], "OtherATMServices":[{ "Code":"stri", "Description":"string", "Name":"string" }], "Branch":{ "Identification":"N/A" }, "Location":{ "LocationCategory":["ATBE","ATBI","ATBL","ATOT","ATRO","ATRU"], "OtherLocationCategory":[{ "Code":"stri", "Description":"string", "Name":"TELEFONOS DE MEXICO SAB DE CV SAN JERONIMO" }], "Site":{ "Identification":"string", "Name":"string" }, "PostalAddress":{ "AddressLine":"SAN JERONIMO LIDICE", "BuildingNumber":"9", "StreetName":"PINOS", "TownName":"MAGDALENA CONTRERAS", "CountrySubDivision":["CD MEXICO"], "Country":"MX", "PostCode":"10100", "GeoLocation":{ "GeographicCoordinates":{ "Latitude":"19.333474", "Longitude":"-99.215063" } } } }, "FeeSurcharges":{ "CashWithdrawalNational":"20.00 MXN", "CashWithdrawalInternational":"20.00 MXN", "BalanceInquiry":"20.00MXN" } }] }] }], "additionalProp1":"string", "additionalProp2":"string", "additionalProp3":"string" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Version: MXOFv1.0.0, function_name: by getMxAtms, operation_id: MXOFv1.0.0-getMxAtms Tags: ATM, MXOpenFinance,

Head ATMS

Gets header information on the current set of ATM data

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-35001: Consent not found by CONSENT_ID.
  • OBP-35002: The time Consent-ID token was issued is set in the future.
  • OBP-35003: Consent-Id is expired.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: MXOFv1.0.0, function_name: by headMxAtms, operation_id: MXOFv1.0.0-headMxAtms Tags: ATM, MXOpenFinance,