# Integration Guide

Complete your Loyalty API integration. This guide walks you through member registration, transaction monitoring, and the merchant activation support required before merchants can use loyalty at their locations.

## What you need

- API credentials from the Tyro Partner Portal
- A webhook endpoint to receive Loyalty API notifications
- A webhook endpoint to receive merchant onboarding requests (if supporting merchant activation)
- A link to the merchant’s loyalty sign-up form (required for on-terminal sign-up flows)
- A merchant using Tyro Pro Series terminals (for on-terminal loyalty)
- A reward definition per transaction (required for on-terminal loyalty)


Although not required, using Tyro eCommerce can enable card linking through online transactions and help unify in-store and online customer activity.

## Support merchant activation

Before merchants can use your loyalty program at their locations, they must complete merchant activation.

When a merchant submits an onboarding request, Tyro sends a `NEW_ONBOARDING_REQUEST` notification to your registered endpoint. You then retrieve the onboarding request details, review the merchant and location information, configure your system as needed, and submit a decision.

This activation support must be implemented as part of your Loyalty API integration, even though merchant activation occurs after your integration has been completed and certified.

See [Activate a merchant](/app/apis/loyalty/merchant-activation) for the full activation flow, notification payload, identifiers, and decision requirements.

### Step 1: Register a member

Create a loyalty member and link their payment card so Tyro can recognise future transactions made with that card.

Member registration can happen through multiple channels, including:

- terminal-led registration
- eCommerce checkout
- direct registration through your mobile app or website


When a member registers, call the Loyalty API to link their payment card to their loyalty profile.

#### API endpoint


```
POST /loyalty/members
```

#### Registration flows

##### Terminal-based registration

For on-terminal loyalty, the customer scans a QR code on the terminal and completes registration in your loyalty experience.

Your sign-up page must accept a memberReference and locationId query parameters. Those values are passed back to Tyro during member registration so Tyro can identify the payment instrument used by the customer without requiring them to manually enter card details.

p
img
##### E-commerce registration

For eCommerce registration, a customer can link their card through an online payment flow when using Tyro eCommerce. This can help create a single customer profile across in-store and online activity.

p
img
Result
The payment card is linked to the member profile and can be recognised by Tyro on future transactions.

For on-terminal loyalty, handle NEW_REGISTERED_CARD notifications to access pre-accumulated point information stored on the card object.

### Step 2: Customer makes a transaction

When a registered card is used for payment, Tyro recognises the card and prepares a loyalty notification.

Loyalty activity only occurs for merchant locations that have completed merchant activation.

#### What happens during payment

1. Customer presents their registered payment card
2. Tyro processes the payment transaction
3. Tyro recognises the card is linked to a loyalty member
4. Tyro captures transaction details for the loyalty notification
5. For on-terminal loyalty, reward information can be displayed on the terminal screen


After the transaction is processed, Tyro sends a loyalty notification to your system.

Result
The transaction completes successfully. If using on-terminal loyalty with Tyro Pro Series devices, the customer can see earned rewards displayed on the terminal screen.

### Step 3: Receive a loyalty notification

Tyro sends the loyalty partner a notification with transaction details when a registered card is used.

Use this notification to process loyalty activity according to your program rules. Tyro does not require a confirmation response that loyalty has been applied.

#### Important

- Process loyalty activity according to your own program rules
- Store any transaction or reward information required by your system
- Ensure your system can safely handle repeated notifications


Result
Your system receives the loyalty notification with the information required to process loyalty activity.

### Success

You have completed the core Loyalty API integration flow:

1. A member is registered
2. Their payment card is linked
3. Tyro recognises future transactions made with that card
4. Your system receives loyalty notifications for processing


Next, continue to [testing](/app/apis/loyalty/testing) and [go-live readiness](/app/apis/loyalty/go-live).