Register member for loyalty

This endpoint registers a member for a participating location with the loyalty API. This notifies you of all future payments performed by the members at locations you have access to. The payment should have taken place within a 60 minute window of the registration.

Request

Security:

JWT

header Parameters

Authorization

required

string

Default: Bearer {$$.env.access_token}

Request Body schema: application/json

required	object
paymentId required	string Payment Identifier generated from the payment source. It refers to the `transaction.receipt` (from Tyro eCommerce APIs) or otherwise referred to as the RRN.
paymentSource required	string Source of payment. Enum: "EFTPOS" "ONLINE"
locationId required	string Tyro Connect's identifier for the location.

Responses

202

The request has been accepted. The member will be registered when a matching payment is found.

400

When the provided payload is not valid.

401

When you don't have a valid access token.

403

When you don't have the right permissions for a location.

post/loyalty/members

Request samples

Payload
curl
C#
Node.js

application/json

{"origin": {"memberId": "member-1"
},
"paymentId": "6940871887d8",
"paymentSource": "EFTPOS",
"locationId": "cafe-on-main-steet"
}

Response samples

application/json

{"error": "\"paymentId\" is required"
}