{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c2c1ff65-0620-460a-b6d7-52104e95f95a","name":"Financial Institution API","description":"This information is intended as a technical reference for development teams at partner Financial Institutions.\n\nIncluded is a full specification of each of the API endpoints relevant to financial institution partners, including examples and response formats.\n\n# API Overview\n\nThe following applies to all APIs and is considered assumed knowledge in using this specification and throughout.\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 will be marked accordingly.\n\nFields that are not required 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 financial 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\n# Versioning\n\nReceiptable will support, and guarantees, 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\nReceiptable will not only support version pinning through defaults managed by Receiptable against the integrator (financial institution or merchant) for the appropriate environment, sandbox and live, but where specified by the integrator (financial institution or merchant) on the request which will override these settings.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"29072317","collectionId":"c2c1ff65-0620-460a-b6d7-52104e95f95a","publishedId":"2s9YXe7ixw","public":true,"publicUrl":"https://docs.receiptable.co","privateUrl":"https://go.postman.co/documentation/29072317-c2c1ff65-0620-460a-b6d7-52104e95f95a","customColor":{"top-bar":"FFFFFF","right-sidebar":"1E1E1E","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/c5af3b56-7a97-4488-a7cb-12d692bd1e6d/U3F1YXJlIFdoaXRlIExvZ28gQmxhY2sgQmFja2dyb3VuZC0wMS5wbmc=","colors":{"top-bar":"1E1E1E","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"1E1E1E","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-11-07T11:54:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":"https://content.pstmn.io/c5af3b56-7a97-4488-a7cb-12d692bd1e6d/U3F1YXJlIFdoaXRlIExvZ28gQmxhY2sgQmFja2dyb3VuZC0wMS5wbmc="}},"statusCode":200},"environments":[{"warning":"Unable to fetch associated environment","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":true,"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":[],"canonicalUrl":"https://docs.receiptable.co/view/metadata/2s9YXe7ixw"}