Get transaction’s details

Integration This method returns all information about a specific Transaction.

get

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

transactionstring · uuidRequired

Transaction ID

Responses

200

Transaction details.

application/json

grossValuenumber · floatOptionalExample: 3

transactionIdstring · uuidOptional

customerIdstring · uuidOptional

matchedbooleanOptional

currencystringOptional

pointsEarnedintegerOptional

unitsDeductedintegerOptional

channelIdstring · uuidOptional

channelNamestringOptional

assignedToCustomerAtstring · date-time · nullableOptional

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/transaction/{transaction}

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

{
  "grossValue": 3,
  "metrics": [
    {
      "name": "text",
      "value": 1,
      "calculatedAt": null
    }
  ],
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerData": {
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[e-mail]",
    "name": "text",
    "nip": "text",
    "phone": "text",
    "loyaltyCardNumber": "text",
    "address": {
      "street": "text",
      "address1": "text",
      "address2": "text",
      "postal": "text",
      "city": "text",
      "province": "text",
      "country": "text"
    }
  },
  "items": [
    {
      "name": "text",
      "highPrecisionQuantity": 1.125,
      "grossValue": 1,
      "category": "text",
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "maker": "text",
      "sku": "text"
    }
  ],
  "header": {
    "documentNumber": "text",
    "documentType": "sell",
    "linkedDocumentNumber": "text",
    "purchasedAt": "2026-01-01T00:00:00.000Z",
    "purchasePlace": "text",
    "excludedDeliverySKUs": [],
    "excludedSKUs": [],
    "excludedCategories": [],
    "labels": []
  },
  "matched": true,
  "currency": "text",
  "pointsEarned": 1,
  "unitsDeducted": 1,
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "channelName": "text",
  "assignedToCustomerAt": "2026-01-01T00:00:00.000Z"
}