{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0c404736-bae6-473b-9687-8d07250dc380","name":"Terminal Integration API","description":"> _Last Updated: 11/02/2026_ \n  \n\nThis information is intended as a technical reference for development teams at acquiring partner institutions.\n\nIncluded is a full specification of each of the API endpoints relevant to terminal integrations, including examples and response formats.\n\n# API Overview\n\nThe following applies to all Receiptable APIs.\n\nThe API is based on RESTful principles with predictable, resource-oriented URLs and uses HTTP response codes to indicate the outcome of the API request.\n\nRequired fields are marked accordingly.\n\nOptional fields may be omitted in requests, and will typically be set to a default value.\n\nThe fields included in a particular response instance may vary according to context, such as the role of the user making the request. For example, some attributes of `Merchant Details` are not available to acquiring institutions and vice versa.\n\nAll responses are returned in a JSON format, including errors.\n\n# Errors\n\nReceiptable adopts and follows standard HTTP response codes to indicate the outcome of an API request, as follows:\n\n- `2XX` indicates success.\n    \n- `3XX` indicates a previous success.\n    \n- `4XX` indicates a failure, with additional information on the reason for the failure.\n    \n- `5XX` indicates an error.\n    \n\nNote: _Sending a receipt with missing mandatory fields, will return a 400 and the response will indicate only the first missing critical field._\n\n# Versioning\n\nReceiptable will support, and guarantee, backward compatibility across the API and the following outlines the affirmative approach and actions :\n\n- Adding new endpoints / resources to the API.\n    \n- Adding new optional request parameters and properties to API methods.\n    \n- Adding new properties to API responses - an integrator (financial institution or merchant) should ignore and gracefully handle unfamiliar properties.\n    \n- Changing the length or format of opaque strings, such as error messages and other human-readable strings.\n    \n- Changing the order of properties on API responses.\n    \n\nFor clarity, the following are not considered affirmative actions, but are included as important for shared understanding:\n\n- Minor versions of the API will not change the name of a field in a data structure or the name of a data structure.\n    \n- Minor versions of the API will not change the datatype of a field or structure.\n    \n\nThe version of the API will determine the behaviour including both the parameters an integrator (financial institution or merchant) can send in requests and properties they will receive in responses.\n\nTo support this behaviour Receiptable supports the following version control headers:\n\n- x-receiptable-version (minor version)\n    \n\nThough this is managed sensibly via Receiptable, the integrator may choose to pin a version of the API via the header `x-receiptable-version`. This setting overrides Receiptable’s managed versioning and may require notifications to update in order to be on the latest version.\n\n# Authorisation\n\nReceiptable uses API key for authorization, please use \\`x-api-key\\` in the header with your registered API key to authorise the endpoint. Partners who wish to manage their own keys can do so via our Auth API, please send an email to \\`[support@receiptable.co](https://mailto:support@receiptable.co)\\`\n\n# Endpoints\n\n_**NOTE: The URL provided in the example is the production URL, when integrating please use our Sandbox URL:**_ `https://terminal.receipt.receiptable-sandbox.io/v1/isreceiptable`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"29072224","team":5451784,"collectionId":"0c404736-bae6-473b-9687-8d07250dc380","publishedId":"2sA3kVjLdr","public":true,"publicUrl":"https://docs.terminal.receiptable.co","privateUrl":"https://go.postman.co/documentation/29072224-0c404736-bae6-473b-9687-8d07250dc380","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2025-11-03T07:19:39.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"receiptable - bahrain - production","id":"047670e9-dc77-4958-875f-79246fecb60b","owner":"29072317","values":[{"key":"receiptable_base_url","value":"api.receiptable.io","enabled":true},{"key":"receiptable_api_version","value":"v1","enabled":true,"type":"default"},{"key":"receiptable_consumer_xref","value":"C-X-12345","enabled":true,"type":"default"},{"key":"receiptable_bearer_token","value":"BQAh79cpxN-h-IbYhKsfYbMaVoliuit9K0TsjbdyjYts9l2_NQzprD0hZz0sh85eXButvkYx-FFLVaKb-xo","enabled":true,"type":"secret"},{"key":"receiptable_client_id","value":"financial_institution_client_id","enabled":true,"type":"default"},{"key":"merchant_identification_number","value":"ALB-120983","enabled":true,"type":"default"},{"key":"merchant_identification_number_2","value":"TKL-298429","enabled":true,"type":"default"},{"key":"receiptable_endpoint_xref","value":"E-X-9e5f6bbc683048b19d71ecdb5ca59227","enabled":true,"type":"default"},{"key":"your_webhook_endpoint","value":"https://api.financial-institution/webhook","enabled":true,"type":"default"},{"key":"receiptable_transaction_xref","value":"T-X-293874562983746523","enabled":true,"type":"default"},{"key":"example_consumer_country_code","value":"The Kingdom of Bahrain is \"BH\"","enabled":true,"type":"default"},{"key":"example_consumer_locality","value":"The name of the municipality or rural locality.","enabled":true,"type":"default"},{"key":"example_consumer_postcode","value":"317","enabled":true,"type":"default"},{"key":"example_consumer_locality_address","value":"Manama","enabled":true,"type":"default"},{"key":"example_consumer_country_code_address","value":"BH","enabled":true,"type":"default"},{"key":"receiptable_client_secret","value":"exaMPLE","enabled":true,"type":"secret"},{"key":"receiptable_terminal_base_url","value":"terminal.receipt.receiptable.io","enabled":true,"type":"default"},{"key":"receiptable_auth_base_url","value":"auth.receiptable.io","enabled":true},{"key":"receiptable_terminal_client_id","value":"terminal_integrator_client_id","enabled":true},{"key":"receiptable_pos_base_url","value":"api.pos.receiptable.io","enabled":true,"type":"default"},{"key":"client_id","value":"pos_client_id","enabled":true,"type":"default"},{"key":"client_secret","value":"pos_client_secret_****","type":"default"}],"published":true}],"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/264c63df7bdf0a08c78051ec75fbfa82eaff082547f6468ff232b2518ce7e5e8","favicon":"https://receiptable.co/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"},{"label":"receiptable - bahrain - production","value":"29072317-047670e9-dc77-4958-875f-79246fecb60b"}],"canonicalUrl":"https://docs.terminal.receiptable.co/view/metadata/2sA3kVjLdr"}