Wallet

These endpoints will allow you to easily manage wallets and wallet types.

Get member’s wallets details

get

Integration 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

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

memberstringRequiredPattern:

[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Query parameters

namestringOptional

createdAtstring · date-timeOptional

walletTypeIdstringOptional

_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

Responses

200

List of wallets

application/json

401Error

application/json

403

Forbidden.

application/json

get/api/{storeCode}/member/{member}/wallet

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

{
  "items": [
    {
      "walletType": {
        "walletTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "unitSingularName": "text",
        "unitPluralName": "text",
        "active": true,
        "isDefault": true,
        "createdAt": "2026-07-18T16:39:35.178Z",
        "limits": {}
      },
      "createdAt": "2026-07-18T16:39:35.178Z",
      "account": {
        "earnedUnits": 1,
        "transferredUnits": 1,
        "spentUnits": 1,
        "activeUnits": 1,
        "lockedUnits": 1,
        "blockedUnits": 1,
        "expiredUnits": 1
      },
      "unitsLimitUsed": 1,
      "unitsLimitRemaining": 1
    }
  ]
}

Check wallet details

get

Management

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

walletstringRequired

Wallet ID

Responses

200

Wallet details

application/json

createdAtstring · date-timeOptional

unitsLimitUsednumber · floatOptional

unitsLimitRemainingnumber · floatOptional

401Error

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/wallet/{wallet}

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

{
  "walletType": {
    "walletTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "unitSingularName": "text",
    "unitPluralName": "text",
    "active": true,
    "isDefault": true,
    "createdAt": "2026-07-18T16:39:35.178Z",
    "limits": {}
  },
  "createdAt": "2026-07-18T16:39:35.178Z",
  "account": {
    "earnedUnits": 1,
    "transferredUnits": 1,
    "spentUnits": 1,
    "activeUnits": 1,
    "lockedUnits": 1,
    "blockedUnits": 1,
    "expiredUnits": 1
  },
  "unitsLimitUsed": 1,
  "unitsLimitRemaining": 1
}

Get wallets list

get

Management 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

activebooleanOptional

isDefaultbooleanOptional

createdAtstring · date-timeOptional

_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

Responses

200

List of walletTypes

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/{storeCode}/walletType

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

{
  "items": [
    {
      "name": "text",
      "walletTypeId": "3eaea517-4336-45c0-b477-f5cc1081fcdb",
      "code": "text",
      "unitSingularName": "text",
      "unitPluralName": "text",
      "active": true,
      "isDefault": true,
      "createdAt": "2026-07-18T16:39:35.178Z",
      "limits": {
        "points": {
          "interval": {
            "type": "calendarHours",
            "value": 1
          },
          "value": 1
        },
        "pointsPerMember": {
          "interval": {
            "type": "calendarHours",
            "value": 1
          },
          "value": 1
        }
      },
      "allowNegativeBalance": true
    }
  ]
}

Add a wallet

post

Management This method allows adding a new wallet to 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

Body

Responses

200

Return created walletType ID.

application/json

walletTypeIdstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

post/api/{storeCode}/walletType

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

{
  "walletType": {
    "translations": {
      "en": {
        "name": "My Wallet"
      }
    },
    "unitSingularName": "point",
    "unitPluralName": "points",
    "active": false,
    "unitDaysExpiryAfter": "all_time_active",
    "allTimeNotLocked": true,
    "allowNegativeBalance": false,
    "code": "my_wallet"
  }
}

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

Check wallet type details

get

Management

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

walletTypestring · uuidRequired

WalletType ID

Responses

200

WalletType details

application/json

walletTypeIdstring · uuidRequiredExample: 3eaea517-4336-45c0-b477-f5cc1081fcdb

codestringRequiredExample: string

unitSingularNamestringRequiredExample: string

unitPluralNamestringRequiredExample: string

activebooleanRequiredExample: true

isDefaultbooleanRequiredExample: true

unitDaysExpiryAfterstringOptionalExample: string

unitDaysActiveCountintegerOptionalExample: 0

unitYearsActiveCountintegerOptionalExample: 0

unitDaysLockedintegerOptionalExample: 0

allTimeNotLockedbooleanOptionalExample: true

createdAtstring · date-timeRequiredExample: 2019-08-24T14:15:22Z

unitExpiryDatestringOptional

Expiration date for unit in format m-d.

Example: 08-24

allowNegativeBalancebooleanOptionalExample: true

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/walletType/{walletType}

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

{
  "translations": {
    "en": {
      "name": "text",
      "description": "text"
    }
  },
  "walletTypeId": "3eaea517-4336-45c0-b477-f5cc1081fcdb",
  "code": "string",
  "unitSingularName": "string",
  "unitPluralName": "string",
  "active": true,
  "isDefault": true,
  "unitDaysExpiryAfter": "string",
  "unitDaysActiveCount": 0,
  "unitYearsActiveCount": 0,
  "unitDaysLocked": 0,
  "allTimeNotLocked": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "unitExpiryDate": "08-24",
  "limits": {
    "points": {
      "interval": {
        "type": "calendarHours",
        "value": 1
      },
      "value": 1
    },
    "pointsPerMember": {
      "interval": {
        "type": "calendarHours",
        "value": 1
      },
      "value": 1
    }
  },
  "allowNegativeBalance": true
}

Update wallet’s configuration

put

Management

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

walletTypestring · uuidRequired

WalletType ID

Body

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

put/api/{storeCode}/walletType/{walletType}

PUT /api/{storeCode}/walletType/{walletType} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 479

{
  "walletType": {
    "translations": {
      "en": {
        "name": "text",
        "description": "text"
      }
    },
    "unitSingularName": "text",
    "unitPluralName": "text",
    "active": true,
    "unitDaysExpiryAfter": "all_time_active",
    "unitDaysActiveCount": 1,
    "unitYearsActiveCount": 1,
    "unitDaysLocked": 1,
    "allTimeNotLocked": true,
    "allowNegativeBalance": false,
    "unitExpiryDate": "08-24",
    "limits": {
      "points": {
        "interval": {
          "type": "calendarHours",
          "value": 1
        },
        "value": 1
      },
      "pointsPerMember": {
        "interval": {
          "type": "calendarHours",
          "value": 1
        },
        "value": 1
      }
    }
  }
}

No content

Last updated 3 days ago

Was this helpful?