Points

These endpoints allow you to easily manage points and points transfers.

Transfer units between members

post

Management This method allows transferring Points between two specific Members.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

Body

Responses

200

Return points transfer ID.

application/json

transferIdstringOptionalExample: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

post/api/{storeCode}/points/transfer

POST /api/{storeCode}/points/transfer HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "transfer": {
    "receiver": "7239e6f7-e52e-466b-8c24-699709b64076",
    "points": 1,
    "comment": "text",
    "sender": "7239e6f7-e52e-466b-8c24-699709b64076"
  }
}

{
  "transferId": "00000000-0000-0000-0000-000000000000"
}

Get unit transfer’s details

get

Management This method returns detailed information about specific transfer in the system.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

Path parameters

storeCodestringRequired

Store code

transferstring · uuidRequired

Points transfer ID

Responses

200

Returned when successful.

application/json

transferIdstring · uuidOptional

typestringOptional

accountIdstringOptional

lockedUntilstring · date-timeOptional

expiresAtstring · date-timeOptional

storeIdstring · uuidOptional

commentstringOptional

cancelledbooleanOptional

pendingbooleanOptional

unlockedAtstring · date-timeOptional

valuenumber · floatOptional

externalTransferIdstringOptional

createdAtstring · date-timeOptional

createdBystring · uuidOptional

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/points/{transfer}

GET /api/{storeCode}/points/{transfer} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "transferId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "accountId": "text",
  "lockedUntil": "2026-07-18T16:39:16.967Z",
  "expiresAt": "2026-07-18T16:39:16.967Z",
  "storeId": "123e4567-e89b-12d3-a456-426614174000",
  "comment": "text",
  "cancelled": true,
  "pending": true,
  "unlockedAt": "2026-07-18T16:39:16.967Z",
  "actionCause": {
    "campaignId": "123e4567-e89b-12d3-a456-426614174000",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "transactionId": "123e4567-e89b-12d3-a456-426614174000",
    "customEventId": "123e4567-e89b-12d3-a456-426614174000",
    "internalEventName": "text",
    "performedAt": "2026-07-18T16:39:16.967Z",
    "rewardId": "text",
    "issuedRewardId": "text"
  },
  "value": 1,
  "externalTransferId": "text",
  "createdAt": "2026-07-18T16:39:16.967Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "walletType": {
    "name": "text",
    "code": "text",
    "unitSingularName": "text",
    "unitPluralName": "text"
  },
  "member": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "phoneNumber": "text",
    "loyaltyCardNumber": "text"
  },
  "labels": {
    "size": "L",
    "color": "blue"
  }
}

Update transfer labels

patch

Management This method allows to update or add labels to an existing transfer.

Usage rules:

Adding: To add a new label, provide a new key with its value.
Editing: To update an existing label, provide its key with a new value.
Removing: To remove an label, provide its key and set the value to null.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

Path parameters

storeCodestringRequired

Store code

transferstring · uuidRequired

Points transfer ID

Body

Responses

204

Returned when successful.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

patch/api/{storeCode}/points/{transfer}

PATCH /api/{storeCode}/points/{transfer} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "transfer": {
    "labels": {
      "size": "L",
      "brand": null
    }
  }
}

No content

Get histogram of number of units

get

Management This method returns histogram of number of Points.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

Path parameters

storeCodestringRequired

Store code

Query parameters

pointTypestring · spent|earned|expired|pendingRequired

Filter by point type

Pattern: (spent|earned|expired|pending)

lastDaysintegerOptional

Range from last X days

Default: 30

futureDaysintegerOptional

Range to X days in the future

Default: 0

intervalstring · day|month|yearOptional

Group by interval

Default: dayPattern: (day|month|year)

Responses

200

Return created message ID.

application/json

Other propertiesnumber · floatOptional

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/{storeCode}/points/history

GET /api/{storeCode}/points/history?pointType=text HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": 1
}

Get units transfers list

get

Management This method returns a list of all Point transfers that have been created in the system. If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an _orderBy parameter in query.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

Path parameters

storeCodestringRequired

Store code

Query parameters

transferIdstring · uuidOptional

Transfer id

accountIdstring · uuidOptionalDeprecated

Owner account id

walletIdstring · uuidOptional

Owner wallet id

typestringOptional

Type

valuenumberOptional

Value

commentstringOptional

Comment

createdBystringOptional

Creator

cancelledbooleanOptional

cancelled

pendingbooleanOptional

pending

createdAtstring · date-timeOptional

createdAt

registeredOnstring · date-timeOptional

registeredOn

lockedUntilstring · date-timeOptional

lockedUntil

expiresAtstring · date-timeOptional

expiresAt

actionCause:transactionIdstringOptional

Transaction id related to

actionCause:campaignIdstringOptional

Campaign id related to

actionCause:customEventIdstringOptional

Custom event id related to

actionCause:internalEventNamestringOptional

Internal event name related to

walletType:codestringOptional

Wallet type code related to

member:idstring · uuidOptional

Member indentifier related to

member:emailstring · emailOptional

Member email related to

member:phoneNumberstringOptional

Member phone number related to

member:loyaltyCardNumberstringOptional

Member loyalty card number related to

_pageinteger · min: 1Optional

Number of page with results, starts from 1

Default: 1Example: 1

_itemsOnPageinteger · min: 1 · max: 50Optional

Items on one page

Default: 10Example: 25

_scrollstringOptional

To use scroll pagination, add the _scroll parameter to your query: ?_scroll

To retrieve the next page, take the scroll value from the previous response and use it in the next request: ?_scroll=eyJjcmVhdGVkQXQiOiIyMDI1LTA3LTAxIDEzOjU2OjI5LjAyMTcwMyIsImlkIjoiNTM5N2RiYzYtZGVkMi00MTQ0LTlhMjQtOTRjYmI5YWVjNDBjIn0=

Notes:

Scroll pagination does not support sorting with _orderBy.
Items are returned in ascending order by the createdAt field by default.

Responses

200

List of transfers

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/{storeCode}/points

GET /api/{storeCode}/points HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "transferId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "accountId": "text",
      "lockedUntil": "2026-07-18T16:39:16.967Z",
      "expiresAt": "2026-07-18T16:39:16.967Z",
      "storeId": "123e4567-e89b-12d3-a456-426614174000",
      "comment": "text",
      "cancelled": true,
      "pending": true,
      "unlockedAt": "2026-07-18T16:39:16.967Z",
      "actionCause": {
        "campaignId": "123e4567-e89b-12d3-a456-426614174000",
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "transactionId": "123e4567-e89b-12d3-a456-426614174000",
        "customEventId": "123e4567-e89b-12d3-a456-426614174000",
        "internalEventName": "text",
        "performedAt": "2026-07-18T16:39:16.967Z",
        "rewardId": "text",
        "issuedRewardId": "text"
      },
      "value": 1,
      "externalTransferId": "text",
      "createdAt": "2026-07-18T16:39:16.967Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "walletType": {
        "name": "text",
        "code": "text",
        "unitSingularName": "text",
        "unitPluralName": "text"
      },
      "member": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phoneNumber": "text",
        "loyaltyCardNumber": "text"
      },
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Activate units transfer

post

Management This method allows activating specific Points transfer.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

Path parameters

storeCodestringRequired

Store code

transferstring · uuidRequired

Points transfer ID

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/points/{transfer}/activate

POST /api/{storeCode}/points/{transfer}/activate HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add an units transfer

post

Management This method allows adding Points transfer to specific Member.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

Path parameters

storeCodestringRequired

Store code

Body

Responses

200

Return points transfer ID.

application/json

transferIdstringOptionalExample: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Forbidden.

application/json

post/api/{storeCode}/points/add

POST /api/{storeCode}/points/add HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "transfer": {
    "customer": "7239e6f7-e52e-466b-8c24-699709b64076",
    "points": 1,
    "expiresInDays": 1,
    "lockedUntilDays": 1,
    "comment": "text",
    "externalTransferId": "text",
    "walletCode": "text",
    "requestedAt": "2026-07-18T16:39:16.967Z",
    "labels": [
      "Nike",
      "L"
    ]
  }
}

{
  "transferId": "00000000-0000-0000-0000-000000000000"
}

Block units

post

Management This method allows blocking Points to specific Member.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

Path parameters

storeCodestringRequired

Store code

Body

Responses

200

Return points transfer ID.

application/json

transferIdstringOptionalExample: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Forbidden.

application/json

post/api/{storeCode}/points/block

POST /api/{storeCode}/points/block HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "transfer": {
    "customer": "7239e6f7-e52e-466b-8c24-699709b64076",
    "points": 1,
    "comment": "text",
    "externalTransferId": "text",
    "walletCode": "text",
    "requestedAt": "2026-07-18T16:39:16.967Z",
    "labels": [
      "Nike",
      "L"
    ]
  }
}

{
  "transferId": "00000000-0000-0000-0000-000000000000"
}

Cancel units transfer

post

Management This method allows canceling a specific Point transfer related to a Member.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

Path parameters

storeCodestringRequired

Store code

transferstring · uuidRequired

Points transfer ID

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/points/{transfer}/cancel

POST /api/{storeCode}/points/{transfer}/cancel HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Spend units

post

Management This method allows spending Points of a specific Member.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

Path parameters

storeCodestringRequired

Store code

Body

Responses

200

Return points transfer ID.

application/json

transferIdstringOptionalExample: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/points/spend

POST /api/{storeCode}/points/spend HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "transfer": {
    "customer": "7239e6f7-e52e-466b-8c24-699709b64076",
    "points": 1,
    "comment": "text",
    "externalTransferId": "text",
    "walletCode": "text",
    "requestedAt": "2026-07-18T16:39:16.967Z",
    "labels": [
      "Nike",
      "L"
    ]
  }
}

{
  "transferId": "00000000-0000-0000-0000-000000000000"
}

Expire units transfer

post

Management This method allows expiring a specific Point transfer related to a Member.

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

Path parameters

storeCodestringRequired

Store code

transferstring · uuidRequired

Points transfer ID

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/points/{transfer}/expire

POST /api/{storeCode}/points/{transfer}/expire HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated 3 days ago

Was this helpful?