Get loyalty activity by Id

This endpoint retrieves a loyalty activity for a registered member.

Request

Security:

JWT

path Parameters

loyaltyActivityId

required

string

ID of loyalty activity to retrieve

header Parameters

Authorization

required

string

Default: Bearer {$$.env.access_token}

Responses

200

401

When you don't have a valid access token.

404

When the provided loyaltyActivityId does not exist.

get/loyalty/activities/{loyaltyActivityId}

Request samples

curl
C#
Node.js

curl -i -X GET \
  'https://api.tyro.com/connect/loyalty/activities/{loyaltyActivityId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"id": "99fdaa02-4cb4-4948-a79e-4b69e4008feb",
"locationId": "e429f245-4dcb-4961-9d27-c40538e990b2",
"memberId": "foo@bar.com",
"payment": {"origin": {"paymentId": "e429f245-4dcb-4961-9d27-c40538e990b2",
"paymentSource": "EFTPOS"
},
"type": "PURCHASE",
"zonedDateTime": "2021-10-11T11:00:01+11:00",
"breakdown": {"goodsAndServices": {"amount": "299",
"currency": "AUD"
},
"cashout": {"amount": "0",
"currency": "AUD"
},
"tip": {"amount": "0",
"currency": "AUD"
},
"surcharge": {"amount": "0",
"currency": "AUD"
}
},
"total": {"amount": "299",
"currency": "AUD"
}
},
"sale": null
}