{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6d738f8a-f4d4-3573-4e5e-2956e061ee41","name":"McDonald's POS code validation API","description":"v2.3.0\n\n## Security\n\nThis API is IP restricted. Client IP address must be provided to Creata for white-listing.\n\nIn addition to an IP white-list, basic HTTPS authentication is implemented using your `client_id` and `client_secret`.\n\n\n## Document Parameters\n\n| parameter | description |\n| ---- | ----------- |\n| `{{url}}` | The base url for the API endpoints. |\n| `{{client_id}}` | The client ID issued by Creata. |\n| `{{client_secret}}` | The client secret issued by Creata. |\n| `{{code}}` | The POS or contingency code. Can be a string or an array of strings. For GET requests send a urlencoded comma delimited string of codes. For POST requests send a JSON array of strings. |\n| `{{customer_id}}` | A unique customer identifier (up to 32 chars) |\n\n## Request Headers\n\nBasic `authorization` header must be included in *ALL* requests.\n\nAuthorization header should be composed of your `{{client_id}}` and `{{client_secret}}`.\n\nThe `content-type` for all *POST* requests must be `multipart/form-data` or `application/json`\n\n## Response\nResponse bodies will be `application/json`.\nPlease see a list of sample requests and responses to the right of each endpoint. Programming language selection is available on the top right of this page.\n\n| parameter | description |\n| ---- | ----------- |\n| `code` | The code that was processed |\n| `valid` | A boolean value indicating if the code was valid. This will not be passed if the system was unable to determine if the code was valid. |\n| `success` | A boolean indicating the status of the requested operation. (POST operations only) |\n| `error` | A dictionary detailing the error that occured. Omitted if no error occured. |\n| `message` | Within `error` dictionary. A user friendly description of the error. |\n| `error_code` | Within `error` dictionary. The error code associated with the encountered error. |\n| `customer_id` | The customer id that was passed when the code was invalidated. This is not returned if no customer id was passed during invalidation. |\n| `transaction` | Dictionary of transaction information. Only returned for valid POS codes. |\n| `store_id` | Within `transaction` dictionary. The store id where the transaction was processed. |\n| `date` | Within `transaction` dictionary. The date of the transaction in YYYY-MM-DD format. |\n| `time` | Within `transaction` dictionary. The time of the transaction in HH:MM:SS 24 hour format. |\n| `dollar_value` | Within `transaction` dictionary. The two least significant integer digits of the total transaction value. |\n\n\n## Error codes\n\n`4xxx` Client errors\n\n`5xxx` Server errors\n\n| error_code | description |\n| ---- | ----------- |\n| 4001 | The code is not valid |\n| 4002 | The code has already been used. |\n| 4003 | You are not authorized to use the resource. |\n| 4004 | No code was revcieved in the request. |\n| 4005 | The code has expired. |\n| 4006 | The code is not yet active. |\n| 4007 | The code was not generated within the promotion period. |\n| 4008 | The code has been used by this customer. |\n| 4009 | The code has already been used by another customer. |\n| 4010 | The customer_id is too long (max 32). |\n| 4011 | customer_id is required |\n| 4012 | customer_id cannot be blank |\n| 4013 | first_name is required |\n| 4014 | last_name is required |\n| 4015 | email is required |\n| 4016 | address is required |\n| 4017 | suburb is required |\n| 4018 | state is required |\n| 4019 | postcode is required |\n| 4020 | promo_state is required |\n| 4030 | reCaptcha is required |\n| 4031 | reCaptcha is invalid |\n| 5000 | An unknown error has occured. |\n| 5001 | An error occured while validating for contingency. |\n| 5002 | Application configuration error, notify maintainer. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2596811","collectionId":"6d738f8a-f4d4-3573-4e5e-2956e061ee41","publishedId":"6tf1Mys","public":true,"publicUrl":"https://docs.mcdpos.creatainteractive.com","privateUrl":"https://go.postman.co/documentation/2596811-6d738f8a-f4d4-3573-4e5e-2956e061ee41","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.11.6","publishDate":"2018-02-02T04:57:34.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://creatainteractive.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.mcdpos.creatainteractive.com/view/metadata/6tf1Mys"}