Error

A valid request URL is required to generate request examples

{
  "id": "b8f1c0d2-6d4f-4a2b-9c31-0f7a2e5d1a94",
  "customerId": "cust-1",
  "kind": "accrual",
  "points": 100,
  "valueCents": 10000,
  "at": "2026-07-28T09:00:00.000Z"
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123
  }
}

Loyalty

Accrue loyalty points for a sale (points de fidélité)

Appends an EARN entry to a customer’s ledger for a settled sale. subtotalCents is the sale subtotal in integer cents; the points granted follow the active program’s accrualPointsPerCent. entryId is the IDEMPOTENCY KEY: supply the sale’s own stable id and a replay returns 409 instead of double-crediting; omit it and the server mints a UUID — never invent a key from a client-side counter, which collides across sessions. 422 when the subtotal is too small to earn a whole point.

POST

/

v1

/

loyalty

/

accruals

Error

A valid request URL is required to generate request examples

{
  "id": "b8f1c0d2-6d4f-4a2b-9c31-0f7a2e5d1a94",
  "customerId": "cust-1",
  "kind": "accrual",
  "points": 100,
  "valueCents": 10000,
  "at": "2026-07-28T09:00:00.000Z"
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123
  }
}

Authorizations

Authorization

string

header

required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Body

application/json

customerId

string

required

Minimum string length: 1

subtotalCents

integer

required

Required range: 0 < x <= 9007199254740991

entryId

string

Optional idempotency key; omit to let the server mint a UUID.

Minimum string length: 1

Response

The appended accrual entry (kind: "accrual").

The appended accrual entry (kind: "accrual").

id

string

required

Minimum string length: 1

customerId

string

required

Minimum string length: 1

kind

enum<string>

required

Available options:

accrual,

redemption

points

integer

required

Required range: 0 < x <= 9007199254740991

valueCents

integer

required

Required range: 0 <= x <= 9007199254740991

at

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$