Member

Overview

The member object identifies a participant in the loyalty program. It is used across endpoints to reference, register, update, or authenticate members using supported identifiers.

When to Use This Object

Include the member object in your request payload when:

• You need to associate an operation with a specific loyalty user
• Identifying a user by phone number, email, or membership key
• Performing lookups, updates, transactions, or benefit calculations

This object is required or optional in the following endpoints:

• /member/register
• /member/update
• /member/details
• /member/shortCode
• /payment
• /transaction
• /event

Supported Identifiers

At least one of the following fields must be included. You can provide more than one to improve accuracy.

Field	Type	Description
phoneNumber	string	Member’s phone number (e.g., "1234567890")
email	string	Member’s email address
membershipKey	string	Unique system-generated member identifier
externalId	string	Optional external reference (e.g., barcode, loyalty card number)

info

Do not include null or empty strings. Send only valid, populated fields.

Single Identifier Example

{
  "member": {
    "phoneNumber": "1234567890"
  }
}

Multiple Identifiers Example

You may include more than one identifier to improve matching accuracy.

{
  "member": {
    "phoneNumber": "1234567890",
    "email": "john.doe@example.com",
    "membershipKey": "2c2b5790-d51a-4e4c-8bc6-dcbbc4155675",
    "externalId": "LOYALTY-001"
  }
}

Member in Transaction Context

This is how the member object is typically used inside a request payload:

{
  "member": {
    "phoneNumber": "1234567890"
  },
  "payment": {
    "action": "pay",
    "amount": 1000
  }
}

Best Practices

• Always validate phone and email formats before sending
• Avoid sending blank, null, or default placeholders
• Use consistent identifiers across API calls to maintain traceability
• Protect personal identifiers via HTTPS and authorization headers

Related Objects

• newMemberData: Used for profile registration or updates
• transaction: Used to log purchases and track itemized activity
• event: Used to track member-related milestones and external actions
• payment: Used for loyalty redemptions and cancellations