getMemberDetails Call

Description

Purpose

This API call verifies whether a user is a registered member and retrieves detailed member information, including:

• Name and contact info
• Points and credit balance
• List of available gifts (assets)
• Optional benefit calculation output

When to Use

• To verify if a member is active
• To show member details at checkout or login
• To allow redemption of member gifts or preparation of benefit calculation

📝 Notes

Sending the Request

• Use the x-return-assets header to filter which assets are returned (active, inactive, or all)
• Use x-return-benefits: true to receive calculated discounts related to the transaction
• If a transaction is sent, member benefits (like discounts or gift eligibility) can be calculated in real-time

Request Format

Headers

Name	Type	Required	Description
x-source-type	string	✅	Type of source (POS, Web, etc.)
x-source-name	string	✅	Client or integration system name
x-pos-id	string	✅	Unique POS terminal ID
x-branch-id	string	✅	Branch/location identifier
x-return-assets	string	❌	Values: active (default), inactive, all
x-return-benefits	boolean	❌	Return benefit calculation (false by default)

Body

{
  "member": {
    "phoneNumber": "530229344"
  },
  "transaction": {
    "transactionId": "TX-DEMO-01",
    "dateTime": "2025-06-17T18:30:00Z",
    "totalAmount": 1500,
    "items": [
      {
        "lineId": "1",
        "code": "LATTE001",
        "name": "Latte",
        "departmentCode": "DRINKS",
        "departmentName": "Beverages",
        "quantity": 1,
        "subtotal": 1500,
        "total": 1500,
        "tags": []
      }
    ],
    "payments": [
      {
        "type": "CASH",
        "amount": 1500
      }
    ],
    "employee": "Demo Cashier"
  },
  "usedAssets": []
}

Response Format

{
  "status": "ok",
  "member": {
    "status": "active",
    "firstName": "John",
    "lastName": "Doe",
    "phoneNumber": "530229344",
    "email": "member@example.com",
    "gdpr": true,
    "termsOfUse": true,
    "birthday": "1990-01-01T00:00:00.000Z",
    "visit": 0,
    "totalSpent": 0,
    "membershipKey": "0fe31b8b-5ad5-48af-81e9-4adc7d596042",
    "points": {
      "balance": 0,
      "useForPayments": false
    },
    "credit": {
      "balance": 0,
      "useForPayments": true
    },
    "assets": [],
    "registeredAt": "2025-06-20T13:34:56.045Z"
  }
}

Error Example

{
  "status": "error",
  "error": {
    "code": "MEMBER_NOT_FOUND",
    "message": "Member not found with the given phone number",
    "details": {
      "phoneNumber": "530229344"
    }
  }
}