Get a loyalty customer's points balance

curl --request GET \
  --url https://api.sandbox.primer.io/loyalty-customers/{id} \
  --header 'X-API-KEY: <api-key>'

{
  "id": "waon-customer-123",
  "connectionId": "waon-123",
  "connectionName": "WOAN",
  "balance": 500
}

Get a loyalty customer's points balance

The Loyalty API is currently in beta.

Please contact our Support Team via our Support Portal for access to the Beta. If you don’t have access, please contact your account administrator for assistance.

Not yet integrated with Primer and interested in learning more? Contact us.

Create an API key with the loyalty-transactions:read scopes.

Get a loyalty customer by ID and connection ID. This includes the customer’s points balance.

The connectionId is the unique Primer identifier for your loyalty provider connection. Primer will provide this once the loyalty provider connection is created.

The customerId refers to the customer identifier on the loyalty provider’s side.

GET

loyalty-customers

{id}

Get a loyalty customer's points balance

curl --request GET \
  --url https://api.sandbox.primer.io/loyalty-customers/{id} \
  --header 'X-API-KEY: <api-key>'

{
  "id": "waon-customer-123",
  "connectionId": "waon-123",
  "connectionName": "WOAN",
  "balance": 500
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

string

required

The unique identifier for the customer on the loyalty provider.

Query Parameters

connectionId

string

required

ID of the Primer connection configuration.

Response

Successful Response

string

The unique identifier for the customer on the loyalty provider.

connectionId

string<uuid>

ID of the Primer connection configuration.

connectionName

string

Name of the loyalty provider.

balance

integer

The loyalty customer's points balance.

Update the default saved payment method List the transactions for a customer

API reference

Authorizations

Path Parameters

Query Parameters

Response