-
Dynamic Resource Doc
-
In OBP we largely define our endpoints using an internal case class or model called ResourceDocMore...
- A test endpoint
-
MXOFv1.0.0 (17 APIs)
Get ATMS
Gets a list of all ATM objects.
Authentication is Mandatory
JSON response body fields:
-
ATM: ATM
-
ATMServices: ATMServices
-
Access24HoursIndicator: Access24HoursIndicator
-
Accessibility: Accessibility
-
AddressLine: AddressLine
-
Agreement: Agreement
-
BalanceInquiry: BalanceInquiry
-
Branch: Branch
-
Brand: Brand
-
BrandName: BrandName
-
BuildingNumber: BuildingNumber
-
CashWithdrawalInternational: CashWithdrawalInternational
-
CashWithdrawalNational: CashWithdrawalNational
-
[Code](/glossary#Transaction Requests.Transaction Request Refund Reason Code): 125
-
Country: Country
-
CountrySubDivision: CountrySubDivision
-
Description: This an optional field. Maximum length is 2000. It can be any characters here.
-
FeeSurcharges: FeeSurcharges
-
GeoLocation: GeoLocation
-
GeographicCoordinates: GeographicCoordinates
-
Identification: Identification
-
LastUpdated: LastUpdated
-
Latitude: 38.8951
-
LocationCategory: LocationCategory
-
Longitude: -77.0364
-
MinimumPossibleAmount: MinimumPossibleAmount
-
Name: ACCOUNT_MANAGEMENT_FEE
-
Note: Note
-
OtherATMServices: OtherATMServices
-
OtherAccessibility: OtherAccessibility
-
OtherLocationCategory: OtherLocationCategory
-
PostalAddress: PostalAddress
-
Site: Site
-
StreetName: StreetName
-
SupportedCurrencies: SupportedCurrencies
-
SupportedLanguages: SupportedLanguages
-
TermsOfUse: TermsOfUse
-
TotalResults: TotalResults
-
TownName: TownName
-
additionalProp1: additionalProp1
-
additionalProp2: additionalProp2
-
additionalProp3: additionalProp3
-
[data](/glossary#Scenario 6: Update credit score based on transaction and device data.): data
-
jvalueToCaseclass: jvalueToCaseclass
{
"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"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Head ATMS
Gets header information on the current set of ATM data
Authentication is Mandatory
JSON response body fields:
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.