{"info":{"_postman_id":"962cda89-6606-4f2e-918e-ae4f64f1c848","name":"Slyp Bank Integration API v1.3","description":"

Welcome to the Slyp Bank API!

This 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.

For any assistance, error reporting or feedback please contact dev@slyp.com.au

API

The following applies to the entire Slyp API, and is considered assumed knowledge throughout the rest of this resource.

The 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.

Data 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.

JSON is returned by all API responses, including errors.

Errors

Slyp makes use of standard HTTP response codes to indicate the outcome of an API request, as follows:

2XX response codes indicate success,
3XX response codes indicate a previous success,
4XX response codes indicate a failure, with additional information provided to elaborate on the reason for the failure,
5XX response codes indicate an error within the Smart Receipt solution.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	HTTP CODE SUMMARY
200 - OK	Everything worked as expected.
201 - Created	The resource was created successfully. Resulting from a successful `POST` request.
400 - Bad Request	The request was invalid - generally due to missing, required or invalid parameters.
401 - Unauthorized	The API key or JWT provided was invalid or not authorised for this resource or action.
402 - Request Failed	The parameters were valid but the request failed.
404 - Not Found	The requested resource doesn't exist.
409 - Conflict	The resource already exists. Generally resulting from using the same idempotent key.
429 - Too Many Requests	Too many requests hit the API too quickly. We recommend an exponential back-off of your requests.
500, 502, 503, 504 - Server Errors	Something went wrong on our end. (These are rare.)

Error Response Sample:

{\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

Pagination

All 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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	ARGUMENTS
limit Integer Default: 10	A limit on the number of objects to be returned per page, between 1 and 100.
offset Integer Default: 0	The number of records to skip offset by.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	LIST RESPONSE FORMAT
current_offset Integer	The offset used for this query from 0 index (the first item is item 0).
next_offset Integer	The offset the client should use when making the next query to get the next 'page'.
items Array	An array containing the actual response elements, paginated by any request parameters.
total Integer	The total number of records available for given request parameters.

Example 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

Sorting

API 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.

The 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.

By 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.

Versioning

When 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
As a precaution, use API versioning to test a new API version before committing to an upgrade.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API","slug":"api"},{"content":"Errors","slug":"errors"},{"content":"Pagination","slug":"pagination"},{"content":"Sorting","slug":"sorting"},{"content":"Versioning","slug":"versioning"}],"owner":"6320148","collectionId":"962cda89-6606-4f2e-918e-ae4f64f1c848","publishedId":"SzYT5hFD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-03-25T06:35:24.000Z"},"item":[{"name":"Authenticate","item":[{"name":"Get an Access Token using MTLS","id":"d2b03a19-948b-4a08-ab9a-4b99adf0fbe0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://auth.api.uat-slyp.com.au","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"962cda89-6606-4f2e-918e-ae4f64f1c848","id":"962cda89-6606-4f2e-918e-ae4f64f1c848","name":"Slyp Bank Integration API v1.3","type":"collection"}},"urlObject":{"protocol":"https","host":["auth","api","uat-slyp","com","au"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2b03a19-948b-4a08-ab9a-4b99adf0fbe0"}],"id":"0b433b54-d7b5-44be-aa3e-4d35806229ce","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Document comments	Version	Date
Initial technical specification	1.0	29 November 2019
Updated X.509 field specification	2.0	3 December 2019
Amended technical documentation; updated endpoint URL	2.1	23 December 2019
Updated CA information and X.509 field specification	3.0	14 February 2020

Technical Overview

This document is intended for a Slyp enabled Bank engineering team to connect to the Slyp authentication service,\nfor the purposes of integrating a Bank with Slyp.\nSlyp implements a Mutual TLS (MTLS) authentication protocol which requires both developers and production machines\nto use Public Key Infrastructure (PKI). This enables both the Slyp host server and its participating Bank clients to cryptographically (and mutually) authenticate their identity with Slyp before generating a Bank-scoped, short lived JWT token\nfor use with the Slyp API.\nThe Slyp API documentation will be supplied to a connecting party separately.

X.509 Certificate Authority

The current Certificate Authority (CA) for Slyp is GlobalSign. More information about GlobalSign and its trust services can be found at https://www.globalsign.com

X.509 Certificate Authority trust chain

To use MTLS with Slyp under the GlobalSign Root certificate, your systems must trust:\n - GlobalSign Root CA - R3 (d6:9b:56:11:48:f0:1c:77:c5:45:78:c1:09:26:df:5b:85:69:76:ad)\n -- GlobalSign RSA OV SSL CA 2018 (df:e8:30:23:06:2b:99:76:82:70:8b:4e:ab:8e:81:9a:ff:5d:97:75)

X.509 Certificate Types for Developer Testing and Production Systems

Slyp supports the use of Bank-scoped developer certificates for the purposes of System Integration Testing (SIT), and will sign certificates that differentiate between clients that are Bank engineering team staff and production system clients.\nTo inspect the type of certificate you will be generating, a configuration file client.cnf will be distributed as a part of this ZIP archive (the \"Slyp authentication development kit\").

X.509 Subject for Bank engineering team

The X.509 subject for developer testing client certificates will be of the form:\n C = AU\n ST = New South Wales\n L = Sydney\n O = Slyp Pty Ltd\n CN = .bank.test.slyp.com.au

X.509 Subject for production system clients

The X.509 subject for production system client certificates will be of the form:\n C = AU\n ST = New South Wales\n L = Sydney\n O = Slyp Pty Ltd\n CN = .bank.prod.slyp.com.au

Required Software and Tooling

To request a Bank-scoped client certificate for use with the Slyp authentication service via MTLS,\nyou must have OpenSSL, or equivalent, to generate X.509 client certificates.

Generating a Bank-scoped X.509 client certificate

Step 1.

To request an X.509 client certificate from Slyp, you must first generate and secure in accordance with the Slyp\nkey management policies, a private key to identify the user or production machine that will connect to the Slyp authentication\nservice.\nThis is achieved by running:\n openssl genrsa -aes256 -passout stdin -out client-key.pem 4096\nand supply a passphrase at the command line.

Step 2.

With your newly generated client certificate, you can now request a bank-scoped developer or production machine certificate\nby using your private key to create a certificate signing request (CSR).\nThe type of certificate you request will be included in your Slyp authentication development kit package as client.cnf and\ndistributed to you with this documentation.\nTo generate the CSR, execute:\n openssl req -new -config client.cnf -key client-key.pem -out client-csr.pem

Step 3.

The resultant CSR file must be sent to the certificate authority, Slyp, to sign and return the requested client certificate.\nThe method for sending and receiving CSR correspondence is via email, at the address:\n pki@slyp.com.au\nThe generated client-csr.pem file is non-sensitive, and will be verified by Slyp for its client eligibility.\nUpon receiving the CSR, Slyp will verify the legitimacy of the CSR and provide a client certificate to the requester if eligible.

Step 4.

Once you have obtained a client certificate, you may now load into the JWT requesting software:

ca-crt.pem - the Slyp Root Certificate Authority certificate
client-crt.pem - your CA-signed X.509 client certificate
client-key.pem - your private key\nand request a JWT by making an MTLS secured HTTP GET request to:\nhttps://auth.api.slyp.com.au/

\n","event":[{"listen":"prerequest","script":{"id":"e8a384dd-1322-4664-8d80-fdcec69d04b6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a7362377-ab2d-488d-b5fa-7f3181e563b4","type":"text/javascript","exec":[""]}}],"_postman_id":"0b433b54-d7b5-44be-aa3e-4d35806229ce","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"962cda89-6606-4f2e-918e-ae4f64f1c848","id":"962cda89-6606-4f2e-918e-ae4f64f1c848","name":"Slyp Bank Integration API v1.3","type":"collection"}}},{"name":"Consumer","item":[{"name":"Create a new Consumer","event":[{"listen":"test","script":{"id":"3d4134db-6efe-416b-92f1-359ac58897b6","exec":["var jsonData = JSON.parse(responseBody);","","if (responseCode.code === 200) {"," pm.environment.set(\"consumer-id\", jsonData.id);","}","","if (data.test !== \"true\" | data.test_bank === \"positive\") {"," tests[\"Status code is 200\"] = responseCode.code === 200;","} else {"," tests[\"Status code is 401\"] = responseCode.code === 401;","}"],"type":"text/javascript"}}],"id":"d9562646-6b52-4f60-9e0e-341b1dede1e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"hPHlYbgz2HcYHWh3YBOm90DePG6tofMd\",\n \"address\": {\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country_code\": \"au\"\n },\n \"date_of_birth\": {\n \t\"date\": \"1991-01-01\",\n \t\"fidelity\": \"age_range\"\n },\n \"gender\": \"female\",\n \"is_active\": true\n}"},"url":"{{apiPrefix}}/consumers","urlObject":{"path":["consumers"],"host":["{{apiPrefix}}"],"query":[],"variable":[]}},"response":[{"id":"ca9a483a-4d7c-4425-8c21-59bc44cdd81b","name":"Create a new Consumer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"hPHlYbgz2HcYHWh3YBOm90DePG6tofMd\",\n \"address\": {\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country_code\": \"au\"\n },\n \"date_of_birth\": {\n \t\"date\": \"1991-01-01\",\n \t\"fidelity\": \"age_range\"\n },\n \"gender\": \"femail\",\n \"is_active\": true,\n}"},"url":"{{apiPrefix}}/consumers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 22 Jul 2019 05:04:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"880"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.13.0"},{"key":"X-Protected-By","value":"Sqreen"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,PUT,POST,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, Content-Length, X-Requested-With"},{"key":"ETag","value":"W/\"370-cssKad80sd97z1Y5HsHynhcTptg\""}],"cookie":[],"responseTime":null,"body":"{\n \"xref\": \"C-X-e477226babc154ee6f6487b635696e4e409849b4\",\n \"external_id\": \"hPHlYbgz2HcYHWh3YBOm90DePG6tofMd\",\n \"address\": {\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country_code\": \"au\"\n },\n \"date_of_birth\": {\n \t\"date\": \"1991-01-01\",\n \t\"fidelity\": \"age_range\"\n },\n \"gender\": \"female\",\n \"is_active\": true\n}"}],"_postman_id":"d9562646-6b52-4f60-9e0e-341b1dede1e3"},{"name":"Get a single Consumer record","event":[{"listen":"test","script":{"id":"3ba0254c-ca1b-48c2-a4e4-d2e638d56c85","exec":["var jsonData = JSON.parse(responseBody);","","if (responseCode.code === 200) {"," pm.environment.set(\"consumer-id\", jsonData.id);","}","","if (data.test !== \"true\" | data.test_bank === \"positive\" | data.test_consumer === \"positive\") {"," tests[\"Status code is 200\"] = responseCode.code === 200;","} else {"," tests[\"Status code is 401\"] = responseCode.code === 401;","}"],"type":"text/javascript"}}],"id":"69334db0-f409-4851-952b-3e27207d2c3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"url":"{{apiPrefix}}/consumers/{{consumer-xref}}","urlObject":{"path":["consumers","{{consumer-xref}}"],"host":["{{apiPrefix}}"],"query":[],"variable":[]}},"response":[{"id":"714302ce-515d-437c-9fb6-521627cfcd22","name":"Get a single Consumer record","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"url":"{{apiPrefix}}/consumers/{{consumer-xref}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 22 Jul 2019 05:04:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"910"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.13.0"},{"key":"X-Protected-By","value":"Sqreen"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,PUT,POST,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, Content-Length, X-Requested-With"},{"key":"ETag","value":"W/\"38e-Xeg5FlV8G+GfgBOMBmoZtFbU6uA\""}],"cookie":[],"responseTime":null,"body":"{\n \"xref\": \"C-X-e477226babc154ee6f6487b635696e4e409849b4\",\n \"external_id\": \"hPHlYbgz2HcYHWh3YBOm90DePG6tofMd\",\n \"address\": {\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country_code\": \"au\"\n },\n \"date_of_birth\": {\n \t\"date\": \"1991-01-01\",\n \t\"fidelity\": \"age_range\"\n },\n \"gender\": \"female\",\n \"is_active\": true\n}"}],"_postman_id":"69334db0-f409-4851-952b-3e27207d2c3a"},{"name":"Update an existing Consumer","event":[{"listen":"test","script":{"id":"a5948120-6bc7-4f45-997d-e720679711bb","exec":["if (data.test !== \"true\" | data.test_bank === \"positive\") {"," tests[\"Status code is 200\"] = responseCode.code === 200;","} else {"," tests[\"Status code is 401\"] = responseCode.code === 401;","}"],"type":"text/javascript"}}],"id":"49d9c6e1-4437-4163-ae84-dd38d1debf7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country_code\": \"au\"\n },\n \"date_of_birth\": {\n \t\"date\": \"1991-01-01\",\n \t\"fidelity\": \"age_range\"\n },\n \"gender\": \"male\",\n \"is_active\": false\n}\n"},"url":"{{apiPrefix}}/consumers/{{consumer-xref}}","urlObject":{"path":["consumers","{{consumer-xref}}"],"host":["{{apiPrefix}}"],"query":[],"variable":[]}},"response":[{"id":"c5ed0640-b57f-4abf-8eeb-76c55f526f59","name":"Update an existing Consumer","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country_code\": \"au\"\n },\n \"date_of_birth\": {\n \t\"date\": \"1991-01-01\",\n \t\"fidelity\": \"age_range\"\n },\n \"gender\": \"male\",\n \"is_active\": false\n}"},"url":"{{apiPrefix}}/consumers/{{consummer-xref}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Length","value":"0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"49d9c6e1-4437-4163-ae84-dd38d1debf7a"},{"name":"Delete a single Consumer record","event":[{"listen":"test","script":{"id":"ca43f23a-86ac-46e9-8ec3-a6a8b025b7a7","exec":["if (data.test !== \"true\" | data.test_bank === \"positive\") {"," tests[\"Status code is 200\"] = responseCode.code === 200;","} else {"," tests[\"Status code is 401\"] = responseCode.code === 401;","}"],"type":"text/javascript"}}],"id":"0be46fef-06b0-4f59-9056-d747b6f86e40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"body":{"mode":"raw","raw":""},"url":"{{apiPrefix}}/consumers/{{consumer-xref}}","urlObject":{"path":["consumers","{{consumer-xref}}"],"host":["{{apiPrefix}}"],"query":[],"variable":[]}},"response":[{"id":"0b290edc-3000-45a2-950d-7960cdd7db14","name":"Delete a single Consumer record","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"body":{"mode":"raw","raw":""},"url":"{{apiPrefix}}/consumers/{{consumer-xref}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"0be46fef-06b0-4f59-9056-d747b6f86e40"}],"id":"adb9baa3-c9cd-4e94-97f2-5e6677e77382","description":"

The /Consumers endpoint allows a participating Bank to register and manage a Consumer for the Slyp Smart Receipts solution.

\n
Note Functions relating to surfacing full receipt details and the interaction with that receipt are handled directly by the Slyp SDK.
\n

Consumer

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
xref String Returned only	Slyp's external reference ID for the given consumer. This field cannot be set or edited. Generated by Slyp and used for lookups, updates, and deletes.
external_id String	Optional Client provided ID for the given consumer. Must be unique.
address StreetAddress	The street address of the account holder. Specify `suburb`, `state`, `postcode`. Refer to StreetAddress definition.
date_of_birth DateOfBirth Default: null	The account holders date of birth structure, consisting of a `date` field in `\"YYYY-MM-DD\"` format and an optional (default: `day`) `fidelity` field which can be one of `age_range`, `year`, `month` or `day` representing the accuracy of the date. See examples below.
gender String	The account holders gender. Either `male`, `female` or a string for other where required.
is_active Boolean Default is `true`	Is this consumer active to receive smart receipts.

StreetAddress

Structure containing the consumers address information.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
state String	The state, one of `NSW`, `VIC`, `WA`, `QLD`, `NT`, `TAS` or `ACT`.
postcode* String	The four digit (AU) postcode.
country_code* String	The ISO 3166 Alpha-2 country code. Australia is `\"AU\"`.

DateOfBirth

The string format must remain consistent even when providing low fidelity information. For example, if providing only a consumers year of birth, the month and day field may both simply be set to 01:

{\n    \"date\": \"1980-01-01\",\n    \"fidelity\": \"year\"\n}\n

When providing only age range information, the date in the middle of the age range should be provided. For example, if it is currently 2020 and a consumer is between 24 (born 1996) and 35 (born 1985) years old, the mid point date may be provided as:

{\n    \"date\": \"01-06-1990\",\n    \"fidelity\": \"age-range\"\n}\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c4c9a2d2-0bcc-4d47-9366-e3273faa5666","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bcc9b37d-da6a-41be-b5ca-4d4c6cb8cdae","type":"text/javascript","exec":[""]}}],"_postman_id":"adb9baa3-c9cd-4e94-97f2-5e6677e77382"},{"name":"Consumers Receipts","item":[{"name":"Search Receipts for Consumer","event":[{"listen":"test","script":{"id":"244f0e39-2f82-445e-a706-08246fc04d81","exec":["var jsonData = JSON.parse(responseBody);","","if (responseCode.code === 200 && jsonData.items.length > 0) {"," pm.environment.set(\"receipt-id\", jsonData.items[0].id);","}","","if (data.test !== \"true\" | data.test_bank === \"positive\" | data.test_consumer === \"positive\") {"," tests[\"Status code is 200\"] = responseCode.code === 200;","} else {"," tests[\"Status code is 401\"] = responseCode.code === 401;","}"],"type":"text/javascript"}}],"id":"503557e2-2d06-49ac-9fe2-7a1965ffa52a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"url":"{{apiPrefix}}/consumers/{{consumer-xref}}/receipts?limit=100&from_date=2019-09-09&to_date=2019-09-15&min_amount=200&max_amount=300&tags=tax,business,personal","urlObject":{"path":["consumers","{{consumer-xref}}","receipts"],"host":["{{apiPrefix}}"],"query":[{"description":{"content":"

optional - defaults to 20.

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"from_date","value":"2019-09-09"},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"to_date","value":"2019-09-15"},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"min_amount","value":"200"},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"max_amount","value":"300"},{"description":{"content":"

optional

\n","type":"text/plain"},"key":"tags","value":"tax,business,personal"}],"variable":[]}},"response":[{"id":"a48dd495-755f-42ea-a2ee-54dbe962db1f","name":"List all Receipts for this Consumer","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"url":{"raw":"{{apiPrefix}}/consumers/{{consumer-xref}}/receipts?limit=100","host":["{{apiPrefix}}"],"path":["consumers","{{consumer-xref}}","receipts"],"query":[{"key":"limit","value":"100","description":"optional - defaults to 20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 22 Jul 2019 05:09:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"417"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.13.0"},{"key":"X-Protected-By","value":"Sqreen"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,PUT,POST,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, Content-Length, X-Requested-With"},{"key":"ETag","value":"W/\"1a1-wjBjV09udOmeLMGqJ/ZgRFiFyDY\""}],"cookie":[],"responseTime":null,"body":"{\n \"current_offset\": 0,\n \"next_offset\": 1,\n \"items\": [\n {\n \"xref\": \"R-X-7afa7ee1b1a6c501cbb00d91e8ece769c5dfdbb9\",\n \"merchant_name\": \"\",\n \"store_name\": \"Slyp Shop Sydney\",\n \"logo_url\": \"https://www.slyp.com.au/logos/Slyp-logo-vertical-RGB-black-text-white-bg.png\",\n \"issued_at\": 1563772101,\n \"is_tax_invoice\": true,\n \"total_tax\": 23.9,\n \"total_price\": 11.5,\n \"currency_code\": \"AUD\",\n \"receipt_type\": \"smart\",\n \"tags\": []\n }\n ]\n}"}],"_postman_id":"503557e2-2d06-49ac-9fe2-7a1965ffa52a"},{"name":"Get a single Receipt for this Consumer","event":[{"listen":"test","script":{"id":"af60e7e8-7d4a-477e-bb90-6e290cd9d1fc","exec":["var jsonData = JSON.parse(responseBody);","","if (data.test !== \"true\" | data.test_bank === \"positive\" | data.test_consumer === \"positive\") {"," tests[\"Status code is 200\"] = responseCode.code === 200;"," ","} else {"," tests[\"Status code is 401\"] = responseCode.code === 401;","}"],"type":"text/javascript"}}],"id":"382dbf5c-db48-4354-9f70-2d6747626cc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access-token}}"}],"url":"{{apiPrefix}}/consumers/{{consumer-xref}}/receipts/{{receipt-xref}}","urlObject":{"path":["consumers","{{consumer-xref}}","receipts","{{receipt-xref}}"],"host":["{{apiPrefix}}"],"query":[],"variable":[]}},"response":[{"id":"fa82ac31-7443-43d8-b33e-3e9771704ff6","name":"Get a single Receipt for this Consumer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access-token}}"}],"url":"{{apiPrefix}}/consumers/{{consumer-xref}}/receipts/{{receipt-xref}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 22 Jul 2019 05:15:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4299"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.13.0"},{"key":"X-Protected-By","value":"Sqreen"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,PUT,POST,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, Content-Length, X-Requested-With"},{"key":"ETag","value":"W/\"10cb-XZeq5Qa/pIYQNw9GjwzTNyC9K/s\""}],"cookie":[],"responseTime":null,"body":"{\n \"xref\": \"R-X-7afa7ee1b1a6c501cbb00d91e8ece769c5dfdbb9\",\n \"basket_items\": [\n {\n \"product\": {\n \"seqno\": 1,\n \"name\": \"Myobi 46cc 16inch 2 Stroke Petrol Chainsaw\",\n \"short_description\": null,\n \"description\": \"A rugged and high-performing power tool to get the job done right. Backed by our reputation for innovative and quality tools and hardware\",\n \"pricing\": {\n \"price\": 209,\n \"tax\": 19,\n \"discount\": 0,\n \"tax_type\": \"AU_GST\",\n \"currency_code\": \"AUD\"\n },\n \"quantity_purchased\": 1,\n \"warranty_period\": 24,\n \"serial_number\": \"319-4599-948\",\n \"barcode\": null,\n \"image_url\": \"http://www.pingdata.com.au/images/smartreceipt/product-sm-1.png\",\n \"external_links\": [\n {\n \"product\": \"http://www.hardwarehouse.com.au/products/details/46cc-2-stroke-chainsaw-400mm\"\n },\n {\n \"documentation\": \"http://www.hardwarehouse.com.au/products/details/46cc-2-stroke-chainsaw-400mm.pdf\"\n },\n {\n \"manufacturer\": \"http://www.myobi.com.au\"\n },\n {\n \"custom\": {\n \"name\": \"Chainsaw School\",\n \"description\": \"Come in an learn how to handle your chainsaw. We'll be showing you the best tips and tricks for begginers through to experienced handlers.\",\n \"url\": \"http://www.hardwarehouse.com.au/schedule/35345\"\n }\n }\n ],\n \"original_invoice_number\": null\n }\n },\n {\n \"product\": {\n \"seqno\": 2,\n \"name\": \"Myobi 12V Cordless Drill\",\n \"short_description\": null,\n \"description\": \"A rugged and high-performing power tool to get the job done right. Backed by our reputation for innovative and quality tools and hardware\",\n \"pricing\": {\n \"price\": 104,\n \"tax\": 9.45,\n \"discount\": 10,\n \"tax_type\": \"AU_GST\",\n \"currency_code\": \"AUD\"\n },\n \"quantity_purchased\": 1,\n \"warranty_period\": 0,\n \"serial_number\": \"319-4599-948\",\n \"barcode\": null,\n \"image_url\": \"http://www.pingdata.com.au/images/smartreceipt/product-sm-2.png\",\n \"external_links\": [\n {\n \"product\": \"http://www.hardwarehouse.com.au/products/details/12v-drill-kit\"\n },\n {\n \"documentation\": \"http://www.hardwarehouse.com.au/products/details/12v-drill-kit.pdf\"\n },\n {\n \"manufacturer\": \"http://www.myobi.com.au\"\n }\n ],\n \"original_invoice_number\": null\n }\n },\n {\n \"adjustment\": {\n \"seqno\": 3,\n \"name\": \"Frequent Shopper\",\n \"description\": \"Loyal customer discount\",\n \"pricing\": {\n \"price\": -50,\n \"tax\": 0,\n \"discount\": 0,\n \"tax_type\": \"AU-GST\",\n \"currency_code\": \"AUD\"\n }\n }\n }\n ],\n \"raw_basket_items\": null,\n \"scanned_receipt\": null,\n \"issued_at\": 1563772101,\n \"merchant_detail\": {\n \"name\": \"Slyp Shop Sydney\",\n \"short_name\": \"Slyp Shop Sydney\",\n \"logo_url\": \"https://www.slyp.com.au/logos/Slyp-logo-vertical-RGB-black-text-white-bg.png\",\n \"receipt_theme\": null,\n \"address\": {\n \"street\": \"255 George St\",\n \"street_2\": null,\n \"suburb\": \"Sydney\",\n \"state\": \"NSW\",\n \"postcode\": \"2000\",\n \"country_code\": \"au\"\n },\n \"phone_number\": \"(02) 9045 0946\",\n \"abn\": \"19 613 031 271\",\n \"external_links\": [\n {\n \"website\": \"https://www.slyp.com.au/\"\n },\n {\n \"facebook\": \"https://www.facebook.com/weareslyp/\"\n },\n {\n \"twitter\": \"https://twitter.com/weareslyp\"\n }\n ],\n \"rendered_opening_hours\": {\n \"current_state\": {\n \"title\": \"Closing soon\",\n \"subtitle\": \"Closes at 4:00pm\",\n \"is_open\": true,\n \"is_soon\": true\n },\n \"opening_hours\": [\n {\n \"label\": \"Monday\",\n \"hours\": [\n \"9:00am-4:00pm\"\n ]\n },\n {\n \"label\": \"Tuesday\",\n \"hours\": [\n \"9:00am-4:00pm\"\n ]\n },\n {\n \"label\": \"Wednesday\",\n \"hours\": [\n \"9:00am-4:00pm\"\n ]\n },\n {\n \"label\": \"Thursday\",\n \"hours\": [\n \"9:00am-4:00pm\"\n ]\n },\n {\n \"label\": \"Friday\",\n \"hours\": [\n \"9:00am-4:00pm\"\n ]\n },\n {\n \"label\": \"Saturday\",\n \"hours\": [\n \"closed\"\n ]\n },\n {\n \"label\": \"Sunday\",\n \"hours\": [\n \"closed\"\n ]\n }\n ]\n },\n \"return_period\": 60,\n \"timezone\": \"Australia/Sydney\"\n },\n \"is_tax_invoice\": true,\n \"total_tax\": 23.9,\n \"total_price\": 11.5,\n \"currency_code\": \"AUD\",\n \"metadata\": \"\",\n \"purchaser\": null,\n \"loyalty_card_transactions\": [],\n \"one_touch_loyalty\": null,\n \"served_by\": {\n \"name\": \"Jessica A\",\n \"position\": \"Store Manager\",\n \"photo_url\": \"https://www.hardwarehouse.com.au/staff/1.png\"\n },\n \"offers\": [],\n \"promotions\": [],\n \"feedback\": [],\n \"returns\": {\n \"return_barcode\": \"123456789012\",\n \"return_period\": 60,\n \"return_reminders_enabled\": true,\n \"return_policy_text\": \"\"\n },\n \"tags\": [],\n \"receipt_type\": \"smart\",\n \"archive\": false,\n \"is_matched\": true,\n \"layout\": [\n \"Announcement\",\n \"ReceiptHeader\",\n \"LineItem\",\n \"Returns\",\n \"StoreDetails\",\n \"ReceiptFooter\"\n ],\n \"footer_links\": [\n {\n \"name\": \"Terms and Conditions\",\n \"description\": \"\",\n \"url\": \"https://slyp.com.au/terms\"\n }\n ],\n \"cards\": [\n {\n \"card_type\": \"visa\",\n \"last4\": \"5555\"\n }\n ]\n}"}],"_postman_id":"382dbf5c-db48-4354-9f70-2d6747626cc7"},{"name":"Download Receipts (CSV or PDF)","event":[{"listen":"test","script":{"id":"920bb63b-5741-401a-958d-29e61fed237c","exec":["",""],"type":"text/javascript"}}],"id":"ea9187c8-5f4c-4c5e-b116-c419ea5367bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access-token}}"},{"key":"Content-Type","value":"text/csv","description":"

Options [\"text/csv\", \"application/pdf\"]

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"ids\": [\n\t\t\"R-X-7afa7ee1b1a6c501cbb00d91e8ece769c5dfdbb9\"\n\t\t]\n}\n"},"url":"{{apiPrefix}}/consumers/{{consumer-xref}}/receipts/export","urlObject":{"path":["consumers","{{consumer-xref}}","receipts","export"],"host":["{{apiPrefix}}"],"query":[],"variable":[]}},"response":[{"id":"66255a63-df64-4df7-843e-765da22f5196","name":"Download Receipts as CSV","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/csv"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"body":{"mode":"raw","raw":"{\n\t\"ids\": [\n\t\t\"R-X-7afa7ee1b1a6c501cbb00d91e8ece769c5dfdbb9\"\n\t\t]\n}\n"},"url":"{{apiPrefix}}/consumers/{{consumer-xref}}/receipts/export"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 22 Jul 2019 05:24:36 GMT"},{"key":"Content-Type","value":"text/csv"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.13.0"},{"key":"X-Protected-By","value":"Sqreen"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,PUT,POST,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, Content-Length, X-Requested-With"}],"cookie":[],"responseTime":null,"body":"\"Merchant name\",\"Street\",\"Street 2\",\"Suburb\",\"State\",\"Postcode\",\"Country code\",\"Phone\",\"ABN\",\"Is tax invoice\",\"Total tax\",\"Total price\",\"Currency code\",\"Issued at\"\r\n\"Slyp Shop Sydney\",\"\",\"\",\"\",\"\",\"\",\"\",\"(02) 9045 0946\",\"19 613 031 271\",\"true\",\"23.9\",\"11.5\",\"AUD\",\"Monday, July 22nd 2019, 5:08:21 am\"\r\n"}],"_postman_id":"ea9187c8-5f4c-4c5e-b116-c419ea5367bf"}],"id":"72795e81-c7d5-4d1e-9ea5-da6b74a7cbb3","description":"

The Receipt includes:

payment data: typically printed on the eftpos receipt; required to match the receipt to the consumer's purchase history, based on the payment card used. Refer to Payment Data definition for more information on card payments and the Other Payment definition for non-card payment support.
basket items: often referred to as the 'basket data' or 'line items', includes the line item details for the purchase. Refer to Basket Items definition for more information.
purchaser information: details of the consumer of this transaction where it is available at POS. This information can be used to deliver a standard digital receipt to the consumer where they are not registered for Smart Receipts - authorised partners only.
loyalty card data: where the consumer has used a loyalty card or program at time of transaction. This data is currently used for display purposes only. Refer to Loyalty definition for more information
other information displayed on a typical receipt (e.g. barcode, pricing, tax invoice status).

ReceiptSummary

The receipt summary is the itemized type returned in the paginated response from the 'search receipts for consumer' request.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
xref String Returned only	Slyp's external reference ID for the given Receipt. This field cannot be set or edited. Generated by Slyp and used for lookups, updates, and deletes.
merchant_name* String	The name of the parent merchant record, will be provided as an empty string if not available for any reason.
store_name* String	The name of the store, typically the value displayed on the receipt to identify the seller. Will be provided as an empty string if not available for any reason.
logo_url* String	The logo of the seller. Will be provided as an empty string if not available for any reason.
replacement_for Nullable String Default: null	The ID of the previous receipt to which this receipt is linked (e.g. for refunds, or when a receipt is replaced for some reason).
replaced_by Nullable String Default: null	If this receipt was replaced, the ID of the new version.
issued_at* Number	The UNIX time (seconds since epoch, UTC time, no timezone) that this receipt was issued to the consumer.
is_tax_invoice Nullable Boolean Default: false	An indication of whether this receipt serves as a tax invoice.
total_tax* Number	The total tax for this purchase.
total_price* Number	The total price for this purchase, including all taxes and discounts.
currency_code* String	The applicable ISO 4217 currency code for the purchase amount. Typically `AUD`. May differ from the currency charged to the payment card.
receipt_type* String	Indicates one of `'smart'` or `'scan'`.
tags Array of Strings Default: []	User set tags on the receipt.

Receipt

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
xref String Returned only	Slyp's external reference ID for the given Receipt. This field cannot be set or edited. Generated by Slyp and used for lookups, updates, and deletes.
merchant_detail* ConsumerMerchantDetail	Refer to ConsumerMerchantDetail definition.
basket_items* BasketItem Array	The items purchased in this transaction. Item types are `product`, `service`, `journey`, `adjustment`. Refer to Basket Item definitions below.
scanned_receipt Nullable String Default: null	Link to the scan of the actual paper receipt, if it exists.
payments PaymentItem Array Default: []	Payment information for the receipt. Refer to PaymentItem definition below.
purchaser Purchaser	Purchaser details if supplied at checkout or linked to a specific transaction by the POS. Refer to Purchaser definition.
issued_at* Number	The UNIX time (seconds since epoch, UTC time, no timezone) that this receipt was issued to the consumer.
is_tax_invoice Nullable Boolean Default: false	An indication of whether this receipt serves as a tax invoice.
total_tax* Number	The total tax for this purchase.
total_price* Number	The total price for this purchase, including all taxes and discounts.
currency_code* String	The applicable ISO 4217 currency code for the purchase amount. Typically `AUD`. May differ from the currency charged to the payment card.
one_touch_loyalty Nullable OneTouchLoyalty
returns Nullable ReceiptReturns Default: null
served_by Nullable Server Default: null	Details of the store staff member who served the consumer. Refer to Server definition.
tags Array of Strings Default: []	User applied tags on the receipt.
receipt_type* ReceiptType	One of `\"smart\"` or `\"scan\"` or `\"slip\"`.
archive* Boolean	Used to soft delete a receipt.
is_matched* Boolean	If the receipt has been matched to a bank transaction.
layout ReceiptLayoutComponent Array Default: []	Where a ReceiptLayoutComponent is one of `Announcement`, `ReceiptHeader`, `LineItem`, `Total`, `Returns`, `StoreDetails`, `Social`, `Tags` or `ReceiptFooter`.
announcements Nullable ReceiptAnnouncement Array Default: []
external_links Nullable ReceiptSocialLink Array Default: []
tax_messages Nullable String Array Default: null
footer_links NamedLink Array Default: null

ConsumerMerchantDetail

Set of attributes relevant to the consumer view of the seller.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
name String	The name of the Merchant.
short_name String	The short version of Merchant name. Can be used as a logo.
parent_name String	The name of the parent Merchant or Organisation.
logo_url String	The logo for the Merchant.
receipt_theme Nullable ReceiptTheme	String Color and Text options for Receipt.
address StreeAddress	The street address of the Merchant. Specify `suburb`, `state`, `postcode`. Refer to StreetAddress definition.
phone_number String	Merchant phone number.
customer_service_number String	Merchant Customer Service number.
abn String	Merchant ABN.
external_links MerchantLink Array Default: []	Links to Merchant's social presence. Options `website`, `livechat`, `customer_service`, `return_policy`, `twitter`, `facebook`, `instagram`, `apple_app_store_id`, `google_play_store_id` or `custom`. Refer to MerchantLink definition.
rendered_opening_hours Nullable RenderedOpeningHours Array Default: null	Merchant hours information. Refer to RenderedOpeningHours definition.
return_period Number Default: 0	Merchants return period.
timezone String	String timezone for Merchant.

ReceiptTheme

Theme colour settings for Receipt SDK.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
background_colour Nullable String Default: null	The background colour that will be used in the render of the merchant within a UI specified by Hex color code, eg. `\"#0000ff\"`.
background_text Nullable String Default: null	The background text colour that will be used in the render of the merchant within a UI specified by Hex color code, eg. `\"#0000ff\"`.
primary_colour Nullable String Default: null	The primary colour that will be used in the render of the merchant within a UI specified by Hex color code, eg. `\"#0000ff\"`.
primary_text Nullable String Default: null	The primary text colour that will be used in the render of the merchant within a UI specified by Hex color code, eg. `\"#0000ff\"`.
secondary_colour Nullable String Default: null	The secondary colour that will be used in the render of the merchant within a UI specified by Hex color code, eg. `\"#0000ff\"`.

StreetAddress

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
street String	The street address including any unit, property number and street name and type.
street_2 String	Additional optional street information.
suburb String	The suburb.
state String	The state.
postcode* String	The four digit (AU) postcode.
country_code* String	The ISO 3166 Alpha-2 country code. Australia is `\"AU\"`.

MerchantLink

A MerchantLink instance is one of the available types: website, livechat, customer_service, return_policy, twitter, facebook, instagram, apple_app_store_id, google_play_store_id or custom. For example:

MerchantLink Example:\n{\n  \"website\": \"http://www.slyp.com.au/\"\n}\n

The custom links take the form name, description, url such as:

MerchantLink custom link example:\n{\n  \"name\": \"Pinterest\",\n  \"description\": \"A social platform not currently supported in Slip's default link types\",\n  \"url\": \"http:/mypinterestlink.com/\"\n}\n

RenderedOpeningHours

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
current_state OpenClosedState	Refer to OpenClosedState definition below.
opening_hours DailyOpeningHours Array	Refer to DailyOpeningHours definition below.

OpenClosedState

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
title String	Current State title.
subtitle Nullable String Default: null	Current state subtitle.
is_open Boolean	If Merchant is open.
is_soon Boolean	If Merchant closes soon.

DailyOpeningHours

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
label String
hours String Array

BasketItem

Represents an individual line item that forms part of the basket data within a receipt. A BasketItem can be one of four possible types of product, service, journey, adjustment. Refer to each types' definition below, each of which include additional information about the item such as its category, warranty and return periods. The rich format of the Smart Receipt solution allows for web-based content to be added to the line item data, including URLs for further item detail and the opportunity to repurchase.

example:

{\n    \"product\": {\n        // Valid product structure goes here, this example is incomplete.\n        \"seqno\": \"1\",\n        \"name\": \"The greatest song in the world\",\n        ...\n    }\n}\n

BasketItem: Product

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
seqno Number	The order in which we render a list of basket items, otherwise we'll render in the order they were provided.
name* String	A short title or name for this line item.
description String	A description of the item to appear in the drop down view of a line item. This field will be distinct from the `name` if present.
pricing* Pricing	Pricing information for this item. Refer to Pricing definition.
taxes Tax Array	Details of any taxes applied to the item. Refer to Tax definition.
quantity_purchased* Number Default: 1	The number of items of this type purchased (or the number of the unit type specified if applicable).
unit_type Nullable String Default: null	One of `g`, `kg`, `m` or `l` if applicable to the this product.
unit_value Nullable Number Default: null	The price per `unit_type` specified, if applicable.
warranty_period Number Default: 0	The warranty period, in months, for this item. If `0`, warranty information is omitted.
serial_number String Default: null	The serial number for this item.
barcode Barcode Default: null	The barcode for this item. Include `id` and `format`. Where `format` is one of `ean13, ean8, ean5, ean2, upc, upcA, itf14, itf, code128`. Refer to Barcode definition.
image_url String	The URL for the image for this item. Slyp caches images locally, please use the web view of receipts to confirm images are displaying correctly.
external_links ProductLink Array	External links of type `product`, `manufacturer`, `documentation`, `custom`. Where `custom` takes the form `name`, `description`, `url`. Refer to ProductLink definition.

ProductAttributes

Common attributes used to describe a specific product. Custom attributes may also be defined where they are not currently defined in our schema.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
size String	Any type of size information. For example small, medium, XXL, etc.
colour String	Any type of descriptive colour information i.e. black, white stripes, etc.
condition String
feature String
width Number	Measure of the width of the item in any standard units.
height Number	Measure of the height of the item in any standard units.
length Number	Measure of the length of the item in any standard units.
netWeight Number	The net weight of the item.
grossWeight Number	The gross weight of the item.
volume Number	The volume of the item.
custom CustomAttribute	A custom attribute definition taking the form `name`, `value`, `description`, where description is optional.

A ProductAttributes example for colour:

{\n    \"colour\": \"teal\"\n}\n

A custom example:

{\n    \"name\": \"texture\",\n    \"value\": \"two day stubble rough\",\n    \"description\": \"This attribute describes the texture of the item, which could be rough or smooth\"\n}\n

ProductIdentifier

An object containing one String with the label of mpn, upc, ean, slug or isbn. Please enquire if other formats are required.

{\n    \"isbn\": \"9788827506301\"\n}\n

BasketItem: Service

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
seqno Number Default: null	The order in which we render a list of basket items, otherwise we'll render in the order they were provided.
name* String	A short title or name for this line item.
description String Default: null	A longer description of the item.
pricing* Pricing	Pricing information for this item. Refer to Pricing definition.
taxes Tax Array	Details of any taxes applied to the item. Refer to Tax definition.
quantity_purchased Number Default: 1	The number of items of this type purchased.
warranty_period Number Default: 0	The warranty period, in months, for this item. If default or `0`, warranty information is omitted.
image_url String Default: null	The URL for the image for this item.
external_links ProductLink Array	External links of type `product`, `manufacturer`, `documentation`, `custom`. Where `custom` takes the form `name`, `description`, `url`. Refer to the ProductLink definition.

BasketItem: Journey

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
seqno Number Default: null	The order in which we render a list of basket items, otherwise we'll render in the order they were provided.
name* String	A short title or name for this line item.
description String	A longer description of the item.
pricing* Pricing	Pricing information for this item. Refer to Pricing definition.
taxes Tax Array	Details of any taxes applied to the item. Refer to Tax definition.
pickup* Location	Where the journey started. You must specify `name`, `position` for each item. Where `position` takes the form `lat` and `lng`. Refer to Location definition.
dropoff* Location	Where the journey ended. You must specify `name`, `position` for each item. Where `position` takes the form `lat` and `lng`. Refer to Location definition.
image_url String	The URL for the image for this item.
external_links ProductLink Array Default: []	External links of type `product`, `manufacturer`, `documentation`, `custom`. Where `custom` takes the form `name`, `description`, `url`. Refer to ProductLink definition.

Location

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
name String	A human readable name for this location, eg. `\"Home\"` or `\"7 Hudson Street, Redfern\"`, or `null`.
position GpsPosition	Specify both `lat` and `lng` for this location, or `null` if not available.

BasketItem: Adjustment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
seqno Number	The order in which we render a list of basket items, otherwise we'll render in the order they were provided.
name* String	A short title or name for this line item.
description String	A longer description of the item.
pricing* Pricing	Pricing information for this item. You must specify `price, tax, discount` for each item. Refer to Pricing definition.
taxes Tax Array	Details of any taxes applied to the item. Provide an array with a single \"TAX_FREE\" tax type object. Refer to Tax definition.

Pricing

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
price* Number	Total final price, including any taxes and discounts.
discount Number Default: 0	Absolute value of any discounts applied.
currency_code String Default: \"AUD\"	The applicable ISO 4217 currency code for the purchase amount. eg. Australian Dollars: `\"AUD\"`.

Tax

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
tax_type* TaxType	The tax type applied, typically `\"AU_GST\"` for Australian Sales although tax free items should be designated with a `\"TAX_FREE\"` type and amount of zero. `\"AU_WET\"` is also supported. Contact Slyp to arrange new tax type definitions as required.
amount* Number	Total of this tax type applied to this item.

ProductLink

A product link can be labelled a link to product, manufacturer, documentation, image_url or a custom NamedLink which must include \nA link to a webpage for the product for further information and reordering example:

{\n    \"product\": \"www.company.com.au/product\"\n}\n

PaymentItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
name String
amount Number	Amount paid via this method in the receipt currency.

Purchaser

Data relating to the purchaser in the transaction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
abn Nullable String Default: null	Customer ABN, required for valid tax invoice where sale total exceeds $1000 AUD.
name Nullable String Default: null	The name on the consumer.
email Nullable String Default: null	The email address of the consumer.
phone Nullable String Default: null	The mobile number of the consumer in E.164 standard format. Only Australian mobile numbers are currently supported. Invalid formatting or international numbers will cause an error.
notification_method String Default: `none`	How the consumer would like to be notified. One of `\"email\"`, `\"sms\"`, `\"none\"`.

OneTouchLoyalty

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
tag_line String	Tagline to be displayed on Consumer's receipt.

ReceiptReturns

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
return_barcode Nullable String Default: null	Return barcode ID.
return_barcode_format Nullable BarcodeFormat Default: null	One of `ean13, ean8, ean5, ean2, upc, upcA, itf14, itf, code128, code128 A/B/C`. Contact Slyp if your desired format is not listed.
return_period Nullable Number Default: null
return_reminders_enabled Boolean Default: true
return_policy_text Nullable String Default: null

Server

Data relating to the the person who serviced or facilitated this purchase.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
name String Default: null	The name of the server.
position String Default: null	Their position or job description i.e. \"Store Manager\".
photo_url String Default: null	A URL for an image of the server.

ReceiptAnnouncement

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
title String
description String
detail_link Nullable NamedLink Default: null

ReceiptSocialLink

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
link_type String
web_url String

NamedLink

A link to a webpage for the product for further information and reordering example:

{\n    \"product\": \"www.company.com.au/product\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"2cc91edd-51fe-47dc-ae78-07df3d9207fc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2d3ac79d-4fd4-4427-8943-36b3bcf6adad","type":"text/javascript","exec":[""]}}],"_postman_id":"72795e81-c7d5-4d1e-9ea5-da6b74a7cbb3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"962cda89-6606-4f2e-918e-ae4f64f1c848","id":"962cda89-6606-4f2e-918e-ae4f64f1c848","name":"Slyp Bank Integration API v1.3","type":"collection"}}},{"name":"Transactions","item":[{"name":"Create Transaction","event":[{"listen":"prerequest","script":{"id":"5bd3159d-7d5c-41a8-87fa-8fe92d6e4111","exec":["// Set up random values for the required fields in the Transaction payload","pm.variables.set(\"transaction_date\", new Date());","pm.variables.set(\"mpan\", \"123456xxxxxx5555\");","pm.variables.set(\"payment_amount\", Math.floor(Math.random() * Math.floor(1000)));","pm.variables.set(\"banks_consumer_id\", \"abfa03ea-7baf-4229-92d6-57c23eb26469\");","pm.variables.set(\"network_merchant_id\", \"825\");","pm.variables.set(\"terminal_id\", \"678\");","pm.variables.set(\"retrieval_reference_number\", \"358\");","pm.variables.set(\"system_trace_audit_number\", \"347\");","pm.variables.set(\"issuing_bank_authorisation_code\", \"549\");","","// The following values may not be available at the Issuing Bank","pm.variables.set(\"pos_ref_no\", \"558\");","pm.variables.set(\"transaction_id\", \"581\");","pm.variables.set(\"reference_id\", \"164\");",""],"type":"text/javascript"}},{"listen":"test","script":{"id":"6c30446d-72b9-4ea1-877f-efd67f6a2ec2","exec":["var jsonData = JSON.parse(responseBody);","","if (data.test !== \"true\" | data.test_bank === \"positive\") {"," tests[\"Status code is 200\"] = responseCode.code === 200;"," pm.environment.set(\"transaction-id\", jsonData.id);","} else {"," tests[\"Status code is 401\"] = responseCode.code === 401;","}"],"type":"text/javascript"}}],"id":"29728803-a4cb-465f-a852-2dbf52f1a698","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access-token}}"}],"body":{"mode":"raw","raw":"{\n \"consumer_xref\": \"C-X-08f323deadbeefa7af34d5feb414ce27\",\n\n \"bank_transaction_id\" : \"\",\n \"scheme_transaction_id\": \"\",\n \n \"message_type_indicator\": \"\",\n\n \"transmission_date_time\": \"2020-03-02T13:25:12+01:00\",\n \"local_transaction_date_time\": \"2020-03-02T13:25:12+01:00\",\n \n \"processing_code\": 123456,\n \"original_processing_code\": 123456,\n \"response_code\": 0,\n\n \"retrieval_reference_number\": \"\",\n \"authorisation_identification_response\": \"\",\n\n \"is_tokenised\": true,\n \n \"card\" : {\n \"bin\": 1234567,\n \"last_four\": 1234\n },\n \n \"token\" : {\n \"bin\": 1234567,\n \"last_four\": 1234\n },\n \n \"amount\": {\n \"transaction\" : {\n \"amount\": \"123.45\",\n \"currency_code\": \"036\"\n }\n },\n \n \"acquirer\": {\n \"system_trace_audit_number\": 123456\n }, \n \n \"merchant\" : { \n \"category_code\": 1234,\n \"network_id\": \"\",\n \"terminal_id\": \"\",\n \"psuedo_terminal_id\": \"\",\n \"name_location\": \"\"\n } \n}"},"url":"{{apiPrefix}}/bank/transactions","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"fb266b06-1dc9-470a-a073-7180e19259bc","id":"fb266b06-1dc9-470a-a073-7180e19259bc","name":"Transactions","type":"folder"}},"urlObject":{"path":["bank","transactions"],"host":["{{apiPrefix}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"29728803-a4cb-465f-a852-2dbf52f1a698"},{"name":"Get a Single Transaction Record","event":[{"listen":"test","script":{"id":"044da093-1815-4509-8c32-426ce7c745fe","exec":["if (data.test !== \"true\" | data.test_bank === \"positive\") {"," tests[\"Status code is 200\"] = responseCode.code === 200;","} else {"," tests[\"Status code is 401\"] = responseCode.code === 401;","}"],"type":"text/javascript"}}],"id":"c48c7bd0-b75a-42e1-bd3e-66d928c6af4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access-token}}"}],"url":"{{apiPrefix}}/transactions/{{transaction-xref}}","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"fb266b06-1dc9-470a-a073-7180e19259bc","id":"fb266b06-1dc9-470a-a073-7180e19259bc","name":"Transactions","type":"folder"}},"urlObject":{"path":["transactions","{{transaction-xref}}"],"host":["{{apiPrefix}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c48c7bd0-b75a-42e1-bd3e-66d928c6af4f"}],"id":"fb266b06-1dc9-470a-a073-7180e19259bc","description":"

The /bank/transactions endpoints allow a participating Bank of the Slyp Smart Receipts solution to submit transaction data for a consumer purchase. Slyp then matches the transaction with a related receipt, making it possible to attribute basket data to individual consumers.

Matching is an asynchronous process as receipts and transactions can be received at varying times and sequences.

Transactions can only be posted for a pre-existing Consumer on Slyp. A Consumer record must be created before creating a Transaction record for them.

\n
Note Transactions can ONLY be created and retrieved, they cannot be modified or deleted.
\n

Transaction

Parameter	Description
consumer_xref* String	The Slyp Consumer ID to which the transaction relates.
bank_transaction_id* String	The banks' transaction ID as is accounted for in the banks' transaction reconciliation system.
scheme_transaction_id* String	The transaction ID as referred to by the scheme. This will usually be the scheme ID for the authorisation message as sent/retrieved from the scheme.
message_type_indicator* String	The Message Type Indicator field as present in the ISO8583 message header.
transmission_date_time* Datetime	The message transmission timestamp in ISO8601 format.
local_transaction_date_time* Datetime	The transaction transmission timestamp in ISO8601 format.
processing_code* String	The ISO8583 processing code attached to the transaction message.
original_processing_code* String	The earliest known ISO8583 processing code as recieved by the bank.
response_code* String	The ISO8583 response code for the transaction.
retrieval_reference_number* String	The ISO8583 message bitmap field 37.
is_tokenised* Boolean	A flag indicating the Card PAN has been tokenised in the processing of this transaction.
card_scheme* String	A string indicating the scheme through which the transaction was recieved.
card_bin* Integer	The Bank Identification Number (BIN) portion of the Card PAN.
card_last_four* Integer	The last four digits of the Card PAN.
token_scheme String	If the transaction was tokenised, a string indicating the scheme through which the transaction was recieved.
token_bin Integer	If the transaction was tokenised, the Bank Identification Number (BIN) portion of the Token PAN.
token_last_four Integer	If the transaction was tokenised, the last four digits of the Token PAN.
currency_code* String	The currency code for the transaction in ISO4217 format.
amount* String	The value of the transaction.
merchant_category_code* Integer	The Merchant Cateogry Code (MCC) for the merchant that accepted the card payment.
merchant_network_id* String	The scheme ID for the merchant that accepted the card payment.
merchant_terminal_id* String	The banks' ID for the merchant terminal that accepted the card payment.
merchant_address* String	The street address of the merchant on file with the bank.
merchant_city* String	The city of the merchant on file with the bank.
merchant_state* String	The state of the merchant on file with the bank.
merchant_postcode* String	The postcode of the merchant on file with the bank.
merchant_country_code* String	The country of the merchant on file with the bank in ISO3166 format.
acquiring_institution_id* Integer	The ID for the bank that acquired the transaction.
acquiring_institution_country_code* Integer	The country of the bank that acquired the transaction in ISO3166 format.

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"78ea69c0-1820-48e3-921a-da01863f7aa5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4d152b2d-132c-4ab0-9fed-bf942ae91404","type":"text/javascript","exec":[""]}}],"_postman_id":"fb266b06-1dc9-470a-a073-7180e19259bc"},{"name":"Network Merchant Ids","item":[{"name":"List all network merchant Ids","event":[{"listen":"test","script":{"id":"e3300737-f9d5-4316-a0e5-d0bb6496c201","exec":["var jsonData = JSON.parse(responseBody);","","if (responseCode.code === 200 && jsonData.items.length > 0) {"," pm.environment.set(\"network-merchant-id\", jsonData.items[0].id);","}","","if (data.test !== \"true\" | data.test_bank === \"positive\" | data.test_consumer === \"positive\") {"," tests[\"Status code is 200\"] = responseCode.code === 200;","} else {"," tests[\"Status code is 401\"] = responseCode.code === 401;","}"],"type":"text/javascript"}}],"id":"03e98ebf-030b-407c-8b01-e1b3a16f9855","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access-token}}","type":"text"}],"url":"{{apiPrefix}}/network-merchant-ids","urlObject":{"path":["network-merchant-ids"],"host":["{{apiPrefix}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"03e98ebf-030b-407c-8b01-e1b3a16f9855"}],"id":"2783faef-d050-4275-bbff-793a0dcdcc43","description":"

The /network-merchant-ids endpoint provides a list of merchants registered at Slyp with the current bank.

This is a paginated response. The items contain a list of strings, representing network-merchant-ids.

We expect that transactions will only be provided for network-merchant-ids that are found in this list.

\n","event":[{"listen":"prerequest","script":{"id":"b57c62e1-c11a-42a3-b7b7-f89523dd7a07","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"09f9e6e5-6e40-4079-8372-daa38cb5c7ab","type":"text/javascript","exec":[""]}}],"_postman_id":"2783faef-d050-4275-bbff-793a0dcdcc43","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"962cda89-6606-4f2e-918e-ae4f64f1c848","id":"962cda89-6606-4f2e-918e-ae4f64f1c848","name":"Slyp Bank Integration API v1.3","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Example of New Merchant","id":"3354aed3-8efe-4073-b02a-829d6b9bc71f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Signature","value":""}],"body":{"mode":"raw","raw":"{\n \"network_merchant_id\": \"the-network-merchant-mid\"\n}"},"url":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"962cda89-6606-4f2e-918e-ae4f64f1c848","id":"962cda89-6606-4f2e-918e-ae4f64f1c848","name":"Slyp Bank Integration API v1.3","type":"collection"}},"urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"3354aed3-8efe-4073-b02a-829d6b9bc71f"},{"name":"Example of Transaction Matched","id":"a92ef672-bf6d-46ec-a4bf-93f25a9ade43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Signature","value":""}],"body":{"mode":"raw","raw":"{\n \"matched_transaction\": {\n \"transaction\": \"725b17862a5289489dcaeb26dab749810146\",\n \"consumer\": \"C-X-123\",\n \"receipt\": \"R-X-123\",\n \"receipt_type\": \"smart\"\n }\n}"},"url":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"962cda89-6606-4f2e-918e-ae4f64f1c848","id":"962cda89-6606-4f2e-918e-ae4f64f1c848","name":"Slyp Bank Integration API v1.3","type":"collection"}},"urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a92ef672-bf6d-46ec-a4bf-93f25a9ade43"}],"id":"43ac1333-df79-44de-bc99-b93f68234d53","description":"

Slyp supports Webhooks to enable eventful applications, time sensitive applications.

To verify the authenticity of Webhooks, we sign the POST payload using HMAC SHA256, providing the signature in the X-Signature custom Header. The secret used for signing is provided by the Bank.

Slyp will POST the Webhook to your registered listener URL with a body containing relevant data for that event. Refer to the specific event definition for the exact payload of that Webhook.

Event Types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Event Name	Description
new_merchant	A new Network Merchant ID (MID) has been added.
transaction_matched	On a successfully matched Receipt event.

Webhook Payloads

For a new_merchant webhook, the payload is:

{\n  network_merchant_id: 'MID-123' // The new Network Merchant ID\n}\n

For a receipt_matched webhook, the payload is:

{\n  matched_transaction: {\n    transaction: 'trID',    // Banks Payment Transaction ID\n    consumer: 'cID,         // Slyp Consumer ID\n    receipt: 'rID',         // Slyp Receipt ID\n    receipt_type: 'smart',  // The type of receipts\n  }\n}\n

","event":[{"listen":"prerequest","script":{"id":"8341c85b-8bbc-4669-80be-7b6427e2732b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3b98b3b4-e999-4f62-8dcf-c13af7edb0af","type":"text/javascript","exec":[""]}}],"_postman_id":"43ac1333-df79-44de-bc99-b93f68234d53","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"962cda89-6606-4f2e-918e-ae4f64f1c848","id":"962cda89-6606-4f2e-918e-ae4f64f1c848","name":"Slyp Bank Integration API v1.3","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"3159adf3-c833-4502-8943-fdafbfc5cdf5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8e99e76d-4ef3-453f-90e8-15410623f8e2","type":"text/javascript","exec":[""]}}]}