{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Introduction","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"introduction","__idx":0},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tyro Embedded Payments SDK"]}," lets you transform your software-based point of sale app (SoftPOS) to allow businesses to accept in-person contactless payments directly ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["on compatible iPhone and Android devices"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Embedded Payments"]}," supports contactless debit and credit cards (Mastercard®, Visa, eftpos and American Express) and digital wallets (Apple Pay, Google Pay, and Samsung Pay)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"use-cases","__idx":1},"children":["Use cases"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tyro Embedded Payments SDK"]},", POS and payments devices are combined in one!"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integrate with Tyro to create a secure and seamless in-store checkout experience with an all-in-one app on a single device."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Make it easy for businesses to set up and scale quickly."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enable merchants to offer customer fulfillment from any device or combination of devices."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POS and payments on the go"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For example at street markets, pop-up shops, events, or after service by tradies."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Clear up the counter, revamp the checkout experience"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For example queue busting during busy time or eliminate the bottleneck of moving a terminal around the venue."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Improve overall customer experience and efficiency by equipping the staff to take payments on the spot, anywhere on the floor."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Leverage the game-changing impact of Embedded Payments"]}," in Food, Retail, Beauty salons and many more innovative use cases for small-medium and large businesses."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-started-checklist","__idx":2},"children":["Get started checklist:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read through the intended ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/assets/sdk_partnerguide_latest.5d5474b9baddd7a3b6d2ce619387a4340a94ca2febd8d05b6556b79a3b3435bf.c3deaaa1.pdf"},"children":["Customer Experience Journey"]}," document:"]}," This document will help you to understand how the merchant will interact with Tyro's integration portal, authorise a device and accept a payment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/tap-to-pay/account-authorisation"},"children":["Implement the Merchant Authorisation Flow"]},":"]}," This workflow allows your merchants POS and device to be enabled for Embedded Payments."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integrate the SDK:"]}," Documentation is available for ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/tap-to-pay/android/integrate-sdk"},"children":["Android"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/tap-to-pay/ios/integrate-sdk"},"children":["iOS"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Certify your app:"]}," Your app must pass a series of tests before it is able to 'go-live'. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/tap-to-pay/going-live/certification"},"children":["These tests can be found here"]},". When you are ready to proceed to this stage, reach out to your Partner Manager to get started."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Important:"]}," If you are developing an iPhone app please do not forget to include Apples mandatory educational elements. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/tap-to-pay/ios/ui-guidelines"},"children":["You can find more detail about this here"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-reference","__idx":3},"children":["API reference"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/tap-to-pay/1.0/connections/create-embedded-payments-connection"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /tap-to-pay/connections"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create embedded payments connection"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/tap-to-pay/1.0/locations/list-embedded-payments-locations"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /tap-to-pay/merchants/{merchantId}/locations"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List embedded payments locations"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/tap-to-pay/1.0/merchants/authorise-embedded-payments-mid-test"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /tap-to-pay/merchants/{merchantId}/authorise/test"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorise a sandbox merchant ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/tap-to-pay/1.0/merchants/fetch-embedded-payments-merchant"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /tap-to-pay/merchants/{merchantId}"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch a merchant"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/tap-to-pay/1.0/merchants/list-embedded-payments-merchants"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /tap-to-pay/merchants"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lists merchants"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/tap-to-pay/1.0/readers/create-reader"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /tap-to-pay/merchants/{merchantId}/readers"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a reader"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/tap-to-pay/1.0/readers/get-reader"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /tap-to-pay/merchants/{merchantId}/readers/{readerId}"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get a reader"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/tap-to-pay/1.0/readers/list-reader"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /tap-to-pay/merchants/{merchantId}/readers"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List readers"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/tap-to-pay/1.0/transactions/get-embedded-payments-transaction"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /tap-to-pay/merchants/{merchantId}/transactions/{transactionId}"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch an embedded payments transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/tap-to-pay/1.0/transactions/list-embedded-payments-transactions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /tap-to-pay/merchants/{merchantId}/transactions"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List embedded payments transactions"]}]}]}]}]}]},"headings":[{"value":"Introduction","id":"introduction","depth":1},{"value":"Use cases","id":"use-cases","depth":2},{"value":"Get started checklist:","id":"get-started-checklist","depth":2},{"value":"API reference","id":"api-reference","depth":2}],"frontmatter":{"title":"Embedded Payments","seo":{"title":"Introduction"}},"lastModified":"2026-09-02T01:02:13.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/in-person-payments/tap-to-pay/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}