"swagger: \"2.0\"\ninfo:\n version: 2.2.4\n title: Atms\n x-ibm-name: atms\n contact:\n name: Openbanking\n url: https:\/\/www.openbanking.org.uk\/\n email: open.banking@santander.co.uk\n termsOfService: \"\"\n license:\n name: Open Licence Terms & Conditions\n url: https:\/\/www.openbanking.org.uk\/open-licence\n description: |-\n Information on our ATMs, including locations and features.\n\n **API Information**\n\n **Title:** ATMs API \n **Protocol:** TLS \n **Open Banking Specification Version:** 2.2.1 \n **Access:** Free to use and no subscription required\n\n The ATM API provides information on all Santander ATMs. Key features are:\n\n * List of all UK ATMs\n * Address and geo-locations\n * Accessibility\n * Supported languages\nbasePath: \/open-banking\/v2.2\nx-ibm-configuration:\n enforced: true\n testable: false\n phase: realized\nschemes:\n - https\nproduces:\n - application\/prs.openbanking.opendata.v2.2+json\npaths:\n \/atms:\n get:\n parameters:\n - name: If-None-Match\n type: string\n required: false\n in: header\n description: The \"If-None-Match\" header field makes the request method conditional\n on a recipient cache or origin server either not having any current representation\n of the target resource. This implementation is ETag compatible with the\n format %x57.2F ; \"W\/\", case-sensitive. A sample of valid Etag could be W\/\"123456789\".\n - name: If-Modified-Since\n type: string\n required: false\n in: header\n description: The \"If-Modified-Since\" header field makes a GET or HEAD request\n method conditional on the selected representation's modification date being\n more recent than the date provided in the field-value. Transfer of the selected\n representation's data is avoided if that data has not changed. The format\n of the date should be HTTP-date format. A sample of valid date could be\n \"Wed, 09 Feb 1994 22:23:32 GMT\"\n description: \"\"\n responses:\n 200:\n description: Successful response.\n schema:\n $ref: '#\/definitions\/AtmsResponse'\n headers:\n Strict-Transport-Security:\n type: string\n description: HTTPS strict transport security header\n default: max-age=31536000\n ETag:\n type: string\n description: A unique ID identifying whether this resource has changed\n Cache-Control:\n type: string\n description: Describes how long this response can be cached\n default: max-age=28800\n X-Frame-Options:\n type: string\n description: Prevent this request from being loaded in any iframes\n default: DENY\n X-Content-Type-Options:\n type: string\n description: Ensures each page has a content type and prevents browsers\n from doing MIME type sniffing\n default: nosniff\n 304:\n description: A GET request was performed and the response is not modified\n headers:\n Strict-Transport-Security:\n type: string\n description: HTTPS strict transport security header\n default: max-age=31536000\n ETag:\n type: string\n description: A unique ID identifying whether this resource has changed\n Cache-Control:\n type: string\n description: Describes how long this response can be cached\n default: max-age=28800\n X-Frame-Options:\n type: string\n description: Prevent this request from being loaded in any iframes\n default: DENY\n X-Content-Type-Options:\n type: string\n description: Ensures each page has a content type and prevents browsers\n from doing MIME type sniffing\n default: nosniff\n 400:\n description: You have sent a request which could not be understood.\n headers:\n Strict-Transport-Security:\n type: string\n description: HTTPS strict transport security header\n default: max-age=31536000\n ETag:\n type: string\n description: A unique ID identifying whether this resource has changed\n Cache-Control:\n type: string\n description: Describes how long this response can be cached\n default: max-age=28800\n X-Frame-Options:\n type: string\n description: Prevent this request from being loaded in any iframes\n default: DENY\n X-Content-Type-Options:\n type: string\n description: Ensures each page has a content type and prevents browsers\n from doing MIME type sniffing\n default: nosniff\n 408:\n description: Your client has failed to submit a request, and a timeout has\n occurred.\n headers:\n Strict-Transport-Security:\n type: string\n description: HTTPS strict transport security header\n default: max-age=31536000\n ETag:\n type: string\n description: A unique ID identifying whether this resource has changed\n Cache-Control:\n type: string\n description: Describes how long this response can be cached\n default: max-age=28800\n X-Frame-Options:\n type: string\n description: Prevent this request from being loaded in any iframes\n default: DENY\n X-Content-Type-Options:\n type: string\n description: Ensures each page has a content type and prevents browsers\n from doing MIME type sniffing\n default: nosniff\n 429:\n description: You have requested this resource too often.\n headers:\n Strict-Transport-Security:\n type: string\n description: HTTPS strict transport security header\n default: max-age=31536000\n ETag:\n type: string\n description: A unique ID identifying whether this resource has changed\n Cache-Control:\n type: string\n description: Describes how long this response can be cached\n default: max-age=28800\n X-Frame-Options:\n type: string\n description: Prevent this request from being loaded in any iframes\n default: DENY\n X-Content-Type-Options:\n type: string\n description: Ensures each page has a content type and prevents browsers\n from doing MIME type sniffing\n default: nosniff\n 500:\n description: An error occurred on the server. No further information is\n available.\n headers:\n Strict-Transport-Security:\n type: string\n description: HTTPS strict transport security header\n default: max-age=31536000\n ETag:\n type: string\n description: A unique ID identifying whether this resource has changed\n Cache-Control:\n type: string\n description: Describes how long this response can be cached\n default: max-age=28800\n X-Frame-Options:\n type: string\n description: Prevent this request from being loaded in any iframes\n default: DENY\n X-Content-Type-Options:\n type: string\n description: Ensures each page has a content type and prevents browsers\n from doing MIME type sniffing\n default: nosniff\n 503:\n description: The service is temporarily unavailable.\n headers:\n Strict-Transport-Security:\n type: string\n description: HTTPS strict transport security header\n default: max-age=31536000\n ETag:\n type: string\n description: A unique ID identifying whether this resource has changed\n Cache-Control:\n type: string\n description: Describes how long this response can be cached\n default: max-age=28800\n X-Frame-Options:\n type: string\n description: Prevent this request from being loaded in any iframes\n default: DENY\n X-Content-Type-Options:\n type: string\n description: Ensures each page has a content type and prevents browsers\n from doing MIME type sniffing\n default: nosniff\n tags:\n - Atms\n summary: \"\"\n operationId: get_atms\n head:\n responses:\n 200:\n description: Successful response.\n 304:\n description: A GET request was performed and the response is not modified\n 500:\n description: An error occurred on the server. No further information is\n available.\n parameters:\n - name: If-None-Match\n type: string\n required: false\n in: header\n description: The \"If-None-Match\" header field makes the request method conditional\n on a recipient cache or origin server either not having any current representation\n of the target resource. This implementation is ETag compatible with the\n format %x57.2F ; \"W\/\", case-sensitive. A sample of valid Etag could be W\/\"123456789\".\n - name: If-Modified-Since\n type: string\n required: false\n in: header\n description: The \"If-Modified-Since\" header field makes a GET or HEAD request\n method conditional on the selected representation's modification date being\n more recent than the date provided in the field-value. Transfer of the selected\n representation's data is avoided if that data has not changed. The format\n of the date should be HTTP-date format. A sample of valid date could be\n \"Wed, 09 Feb 1994 22:23:32 GMT\"\n description: The HEAD method is identical to GET except that the server does\n not return any ATM list\n tags:\n - Atms\n summary: \"\"\n operationId: head_atms\ndefinitions:\n AtmsResponse:\n properties:\n meta:\n $ref: '#\/definitions\/Meta'\n data:\n type: array\n items:\n $ref: '#\/definitions\/ATM'\n required:\n - data\n - meta\n ATM:\n title: ATM\n type: object\n properties:\n Brand:\n description: Brand of the Acquirer of transactions captured by the ATM\n type: array\n title: Brand\n items:\n description: Brand of the Acquirer of transactions captured by the ATM\n type: object\n properties:\n BrandName:\n description: Brand Name that an organisation uses to market its products\n or services to a consumer\n title: BrandName\n type: string\n minLength: 1\n maxLength: 140\n ATM:\n description: ATM information.\n type: array\n title: ATM\n items:\n description: ATM information.\n type: object\n properties:\n Identification:\n description: ATM terminal device identification for the acquirer\n and the issuer.\n title: Identification\n type: string\n minLength: 1\n maxLength: 35\n SupportedLanguages:\n description: Identification of the language name according to\n the ISO 639-1 codes. The type is validated by the list of values\n coded with two alphabetic characters, defined in the standard.\n title: SupportedLanguages\n type: array\n items:\n description: Identification of the language name according to\n the ISO 639-1 codes. The type is validated by the list of\n values coded with two alphabetic characters, defined in the\n standard.\n type: string\n pattern: '[a-z]{2}'\n ATMServices:\n description: Describes the type of transaction available for a\n customer on an ATM.\n title: ATMServices\n type: array\n items:\n description: Describes the type of transaction available for\n a customer on an ATM.\n type: string\n enum:\n - Balance\n - BillPayments\n - CashDeposits\n - CharityDonation\n - ChequeDeposits\n - CashWithdrawal\n - EnvelopeDeposit\n - FastCash\n - MobileBankingRegistration\n - MobilePaymentRegistration\n - MobilePhoneTopUp\n - OrderStatement\n - Other\n - PINActivation\n - PINChange\n - PINUnblock\n - MiniStatement\n Accessibility:\n description: Indicates Types of Accessibility\n title: Accessibility\n type: array\n items:\n description: Indicates Types of Accessibility\n type: string\n enum:\n - AudioCashMachine\n - AutomaticDoors\n - ExternalRamp\n - InductionLoop\n - InternalRamp\n - LevelAccess\n - LowerLevelCounter\n - Other\n - WheelchairAccess\n Access24HoursIndicator:\n description: Indicates that the ATM is available for use by customers\n 24 hours per day\n title: Access24HoursIndicator\n type: boolean\n SupportedCurrencies:\n description: All ISO 4217 defined currency supported by the ATM.\n title: SupportedCurrencies\n type: array\n items:\n description: ISO 4217 defined currency\n type: string\n pattern: '[A-Z]{3}'\n minItems: 1\n MinimumPossibleAmount:\n description: Minimum amount allowed for a transaction in the service.\n title: MinimumPossibleAmount\n type: string\n pattern: ^-?\\d{1,10}\\.?\\d{0,2}$\n Note:\n description: Summary description of the ATM.\n title: Note\n type: array\n items:\n description: maxLength 2000 text\n type: string\n minLength: 1\n maxLength: 2000\n OtherAccessibility:\n description: Enter a new code , name and description for any other\n ATM accessibility options\n type: array\n title: OtherAccessibility\n items:\n description: Enter a new code , name and description for any\n other ATM accessibility options\n type: object\n properties:\n Code:\n description: The four letter Mnemonic used within an XML\n file to identify a code\n title: Code\n type: string\n pattern: ^\\w{0,4}$\n minLength: 0\n maxLength: 4\n Name:\n description: Long name associated with the code\n title: Name\n type: string\n minLength: 1\n maxLength: 70\n Description:\n description: Description to describe the purpose of the\n code\n title: Description\n type: string\n minLength: 1\n maxLength: 350\n required:\n - Name\n - Description\n additionalProperties: false\n OtherATMServices:\n description: Enter a new code , name and description for any other\n ATM Service\n type: array\n title: OtherATMServices\n items:\n description: Enter a new code , name and description for any\n other ATM Service\n type: object\n properties:\n Code:\n description: The four letter Mnemonic used within an XML\n file to identify a code\n title: Code\n type: string\n pattern: ^\\w{0,4}$\n minLength: 0\n maxLength: 4\n Name:\n description: Long name associated with the code\n title: Name\n type: string\n minLength: 1\n maxLength: 70\n Description:\n description: Description to describe the purpose of the\n code\n title: Description\n type: string\n minLength: 1\n maxLength: 350\n required:\n - Name\n - Description\n additionalProperties: false\n Branch:\n description: Information that locates and identifies a specific\n branch of a financial institution.\n type: object\n title: Branch\n properties:\n Identification:\n description: Unique and unambiguous identification of a branch\n of a financial institution.\n title: Identification\n type: string\n minLength: 1\n maxLength: 35\n additionalProperties: false\n Location:\n description: Location of the ATM.\n type: object\n title: Location\n properties:\n LocationCategory:\n description: Indicates the environment of the ATM.\n title: LocationCategory\n type: array\n items:\n description: Indicates the environment of the ATM.\n type: string\n enum:\n - BranchExternal\n - BranchInternal\n - BranchLobby\n - Other\n - RetailerOutlet\n - RemoteUnit\n OtherLocationCategory:\n description: Enter a new code , name and description for any\n other location category\n type: array\n title: OtherLocationCategory\n items:\n description: Enter a new code , name and description for\n any other location category\n type: object\n properties:\n Code:\n description: The four letter Mnemonic used within an\n XML file to identify a code\n title: Code\n type: string\n pattern: ^\\w{0,4}$\n minLength: 0\n maxLength: 4\n Name:\n description: Long name associated with the code\n title: Name\n type: string\n minLength: 1\n maxLength: 70\n Description:\n description: Description to describe the purpose of\n the code\n title: Description\n type: string\n minLength: 1\n maxLength: 350\n required:\n - Name\n - Description\n additionalProperties: false\n Site:\n description: Used by a Financial Institution internally to\n identify the location of an ATM.\n type: object\n title: Site\n properties:\n Identification:\n description: ATM site identification for the Financial\n Institution.\n title: Identification\n type: string\n minLength: 1\n maxLength: 35\n Name:\n description: ATM site name as used by Financial Institution.\n title: Name\n type: string\n minLength: 1\n maxLength: 140\n additionalProperties: false\n PostalAddress:\n description: Information that locates and identifies a specific\n address, as defined by postal services or in free format\n text.\n type: object\n title: PostalAddress\n properties:\n AddressLine:\n description: Information that locates and identifies a\n specific address, as defined by postal services, that\n is presented in free format text.\n title: AddressLine\n type: array\n items:\n description: maxLength 70 text\n type: string\n minLength: 1\n maxLength: 70\n minItems: 0\n maxItems: 7\n BuildingNumber:\n description: Name or Number that identifies the position\n of a building on a street.\n title: BuildingNumber\n type: string\n minLength: 1\n maxLength: 350\n StreetName:\n description: Name of a street or thoroughfare.\n title: StreetName\n type: string\n minLength: 1\n maxLength: 70\n TownName:\n description: Name of a built-up area, with defined boundaries,\n and a local government.\n title: TownName\n type: string\n minLength: 1\n maxLength: 35\n CountrySubDivision:\n description: Identifies a subdivision of a country, for\n instance state, region, county.\n title: CountrySubDivision\n type: array\n items:\n description: maxLength 35 text\n type: string\n minLength: 1\n maxLength: 35\n minItems: 0\n maxItems: 2\n Country:\n description: Nation with its own government, occupying\n a particular territory.\n title: Country\n type: string\n pattern: '[A-Z]{2}'\n PostCode:\n description: Identifier consisting of a group of letters\n and\/or numbers that is added to a postal address to\n assist the sorting of mail.\n title: PostCode\n type: string\n minLength: 1\n maxLength: 16\n GeoLocation:\n description: Geographic location of the ATM specified\n by geographic coordinates or UTM coordinates.\n type: object\n title: GeoLocation\n properties:\n GeographicCoordinates:\n description: Location on the earth specified by two\n numbers representing vertical and horizontal position.\n type: object\n title: GeographicCoordinates\n properties:\n Latitude:\n description: Latitude measured in decimal degrees.\n title: Latitude\n type: string\n pattern: ^-?\\d{1,3}\\.\\d{1,8}$\n Longitude:\n description: |-\n Angular measurement of the distance of a location on the earth east or west of the Greenwich observatory.\n The longitude is measured in decimal degrees.\n title: Longitude\n type: string\n pattern: ^-?\\d{1,3}\\.\\d{1,8}$\n additionalProperties: false\n required:\n - Latitude\n - Longitude\n additionalProperties: false\n required:\n - GeographicCoordinates\n additionalProperties: false\n additionalProperties: false\n required:\n - PostalAddress\n required:\n - Identification\n - SupportedCurrencies\n - Location\n additionalProperties: false\n minItems: 1\n required:\n - BrandName\n - ATM\n additionalProperties: false\n minItems: 1\n Meta:\n title: Meta data\n type: object\n properties:\n LastUpdated:\n type: string\n format: date-time\n example: \"2000-01-01T00:00:00.001Z\"\n TotalResults:\n type: integer\n example: 10\n Agreement:\n type: string\n enum:\n - Use of the APIs and any related data will be subject to the terms of the\n Open Licence and subject to terms and conditions\n example: String\n License:\n description: Change Banking License\n type: string\n format: uri\n enum:\n - https:\/\/www.openbanking.org.uk\/open-licence\n example: String\n TermsOfUse:\n description: Change Banking Terms of Use\n type: string\n format: uri\n enum:\n - https:\/\/www.openbanking.org.uk\/terms\n example: https:\/\/www.openbanking.org.uk\/terms\n required:\n - LastUpdated\n - TotalResults\n - Agreement\n - License\n - TermsOfUse\n Error:\n title: Error\n type: object\n properties:\n status:\n description: This corresponds to the HTTP status code\n type: string\n title:\n description: A short title of the type of error\n type: string\n details:\n description: Further details describing the error\n type: string\n Header:\n title: Header\n type: object\n properties:\n Strict-Transport-Security:\n type: string\n description: HTTPS strict transport security header\n default: max-age=31536000\n ETag:\n type: string\n description: A unique ID identifying whether this resource has changed\n Cache-Control:\n type: string\n description: Describes how long this response can be cached\n default: max-age=28800\n X-Frame-Options:\n type: string\n description: Prevent this request from being loaded in any iframes\n default: DENY\n X-Content-Type-Options:\n type: string\n description: Ensures each page has a content type and prevents browsers from\n doing MIME type sniffing\n default: nosniff\nconsumes:\n - application\/json\nx-ibm-endpoints:\n - endpointUrl: https:\/\/openbanking.santander.co.uk\/sanuk\/external\n description: Endpoint for Open Banking only\n type:\n - production\n"

{}