{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"962cda89-6606-4f2e-918e-ae4f64f1c848","name":"Slyp Bank Integration API v1.3","description":"Welcome to the Slyp Bank API!\n\nThis information is intended as a technical reference for developers at partner Banks. Included is a full specification of each of the Slyp API endpoints relevant to banking partners, including request examples with sample code in multiple languages, use cases and response formats.\n\nFor any assistance, error reporting or feedback please contact dev@slyp.com.au\n\n# API\n\nThe following applies to the entire Slyp API, and is considered assumed knowledge throughout the rest of this resource.\n\nThe Slyp API is based on RESTful principles with predictable, resource-oriented URLs and uses HTTP response codes to indicate successful API calls and errors. The API has built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.\n\nData Type definitions are included throughout this documentation to accompany request/response formats that use them. Required fields marked by an asterisk. Fields that are not required may be omitted in requests, and will typically be set to a default value of `null` unless otherwise stated. The 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 a `Receipt` that are set by Consumers are not available to Merchants and vice versa.\n\nJSON is returned by all API responses, including errors.\n\n\n# Errors\n\nSlyp makes use of standard HTTP response codes to indicate the outcome of an API request, as follows:\n- `2XX` response codes indicate success,\n- `3XX` response codes indicate a previous success,\n- `4XX` response codes indicate a failure, with additional information provided to elaborate on the reason for the failure,\n- `5XX` response codes indicate an error within the Smart Receipt solution.\n\n| |HTTP CODE SUMMARY|\n|---:|---|\n|200 - OK|Everything worked as expected.|\n|201 - Created|The resource was created successfully. Resulting from a successful `POST` request.|\n|400 - Bad Request|The request was invalid - generally due to missing, required or invalid parameters.|\n|401 - Unauthorized|The API key or JWT provided was invalid or not authorised for this resource or action.|\n|402 - Request Failed|The parameters were valid but the request failed.|\n|404 - Not Found|The requested resource doesn't exist.|\n|409 - Conflict|The resource already exists. Generally resulting from using the same idempotent key.|\n|429 - Too Many Requests|Too many requests hit the API too quickly. We recommend an exponential back-off of your requests.|\n|500, 502, 503, 504 - Server Errors|Something went wrong on our end. (These are rare.)|\n\n*Error Response Sample:*\n```JSON\n{\n  \"status\": 401,\n  \"msg\": \"Unauthorized\",\n  \"code\": \"\", // Programatic error codes not yet implemented\n  \"request_id\": \"\", // unimplemented correlation id for the request\n  \"detail\": {} // arbitrary object for including further information or raw error responses\n}\n```\n\n# Pagination\n\nAll top-level API resources have support for bulk fetches via \"list\" API methods. For instance you can list Receipts, list Promotions, and list Merchants. These list API methods share a common structure, taking two optional parameters: `limit` and `offset`.\n<br/>\n\n| |ARGUMENTS|\n|---:|---|\n|**limit**<br/>Integer<br/>Default: 10|A limit on the number of objects to be returned per page, between 1 and 100.|\n|**offset**<br/>Integer<br/>Default: 0|The number of records to skip offset by.|\n\n| |LIST RESPONSE FORMAT|\n|---:|---|\n|**current_offset**<br>Integer|The offset used for this query from 0 index (the first item is item 0).|\n|**next_offset**<br>Integer|The offset the client should use when making the next query to get the next 'page'.|\n|**items**<br/>Array|An array containing the actual response elements, paginated by any request parameters.|\n|**total**<br/>Integer|The total number of records available for given request parameters.|\n\nExample with offset to receive next page after the first 10 have already been received: \n> `.../merchants/:id/receipts?offset=10`\nExample with offset and limit to retrieve only the second item:\n> `.../merchants/:id?receipts?offset=1&limit=1`\n\n# Sorting\n\nAPI responses with lists of data can be sorted by providing a sort parameter in the query string such as `sort=total_price` on a receipts request.\n\nThe parameter may be prepended with a + or - to specify a sort order. The default is ascending (+). eg: `sort=-total_price` would sort items based on the `total_price` field in reverse order.\n\nBy default, if no sort parameters are specified, the sort order is ascending on the default sorting field (typically time based, such as time of creation). Pass `sort=desc` in the query string to reverse the order on the default sorting field.\n\n# Versioning\n\nWhen necessary backwards-incompatible changes to the API are released, we release a new versioned prefix. The current version is `/v1/`. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.\n\n> *As a precaution, use API versioning to test a new API version before committing to an upgrade.*","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6320148","collectionId":"962cda89-6606-4f2e-918e-ae4f64f1c848","publishedId":"SzYT5hFD","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6320148/SzYT5hFD","privateUrl":"https://go.postman.co/documentation/6320148-962cda89-6606-4f2e-918e-ae4f64f1c848","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2020-03-25T06:35:24.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":""},"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://documenter.gw.postman.com/view/metadata/SzYT5hFD"}