Get Account movements

Description

This service retrieves the transaction history (account movements) for a party's account within a specific mileage activity.

---

Request

Restrictions

This service requires an authenticated user and can only be called after a successful consumer login.

Endpoint

GET https://<server-url>/api/v4/mileage/{activity_code}/account/movements

Path Parameters

Parameter	Type	Description
activity_code	String	The unique code for the mileage activity (e.g., "MPOINTS").

Parameters

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.
token	Query / Header	The authentication token for the API session. Use Thalamus-Token for the header.
limit	Query	Optional. An integer to limit the number of movements returned (for pagination).
offset	Query	Optional. An integer to specify the starting point of the movements to return (for pagination).
from	Query	Optional. A date in yyyy-mm-dd format to filter movements from this date forward.
to	Query	Optional. A date in yyyy-mm-dd format to filter movements up to this date.

Full URL Example

https://<server-url>/api/v4/mileage/MPOINTS/account/movements?touchpoint=test&token=...

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

A JSON object is returned containing an array of account movements. Each object in the array represents a single transaction.

Field	Type	Description
date	Timestamp	The date of the transaction.
codeDescription	String	A human-readable description of the movement (e.g., "Checkout").
movementType	String	The type of transaction (Credit or Debit).
amount	Number	The value of the transaction.
balance	Number	The account balance after this transaction.
description1-4	String	Custom description fields for the movement.

JSON

{
  "movements": [
    {
      "order": 2,
      "date": 1691486047000,
      "code": "Checkout",
      "codeDescription": "Items checked out.",
      "movementType": "Credit",
      "amount": 15.0,
      "balance": 90.0,
      "description1": "Checkout"
    },
    {
      "order": 27,
      "date": 1701336005000,
      "code": null,
      "codeDescription": null,
      "movementType": "Debit",
      "amount": 100.0,
      "balance": 90.0,
      "description1": "description 1"
    }
  ]
}

❌ Unsuccessful Response: 404 Not Found

Returned if the specified activity_code does not exist.

JSON

{
  "errors": {
    "error.message": "NOT_FOUND"
  }
}