Comprehensive customer management: single/bulk enrollment, reward balance, transaction history, and personal code management. All endpoints are rate-limited to 10 requests/sec. See method docs for details.
Enroll a single customer into the rewards program.
Use this endpoint to enroll a single customer. The operation is asynchronous; a task ID is returned for tracking.
Enroll a single customer into the rewards program. › Request Body
firstNameThe customer's first name.
lastNameThe customer's last name.
languageThe customer's preferred language (e.g., 'en', 'fr').
dateOfBirthThe member's date of birth in ISO 8601 format (e.g., 1990-01-01T00:00:00Z).
emailThe member's email address. Must be a valid email format.
phoneNumberThe customer's phone number in international format.
assignedReferralCodeCustom referral code to assign. Auto-generated when omitted. Must be unique within the application.
Enroll a single customer into the rewards program. › Responses
Customer enrollment request accepted; task enqueued.
contactThe member's contact information. This is either an email address or a phone number, based on the member's preferred contact method.
personalCodeThe unique alphanumeric personal code assigned to the member for identification and verification purposes.
Enroll multiple customers in bulk.
Use this endpoint to enroll multiple customers in a single request. The operation is asynchronous; a task ID is returned for tracking.
Enroll multiple customers in bulk. › Request Body
firstNameThe customer's first name.
lastNameThe customer's last name.
languageThe customer's preferred language (e.g., 'en', 'fr').
dateOfBirthThe member's date of birth in ISO 8601 format (e.g., 1990-01-01T00:00:00Z).
emailThe member's email address. Must be a valid email format.
phoneNumberThe customer's phone number in international format.
assignedReferralCodeCustom referral code to assign. Auto-generated when omitted. Must be unique within the application.
Enroll multiple customers in bulk. › Responses
Bulk enrollment request accepted; task enqueued.
taskIdstatusRetrieve personal codes for multiple customers by email.
Use this endpoint to retrieve personal codes for multiple customers based on their email addresses.
Retrieve personal codes for multiple customers by email. › Responses
Personal codes retrieved successfully.
contactThe member's contact information. This is either an email address or a phone number, based on the member's preferred contact method.
personalCodeThe unique alphanumeric personal code assigned to the member for identification and verification purposes.
Retrieve the reward balance for a customer by personal code.
Use this endpoint to get the current reward balances for a customer. Balances include all reward types associated with the account.
path Parameters
personalCodeThe Otonum personal code of the customer.
Retrieve the reward balance for a customer by personal code. › Responses
Reward balances retrieved successfully.
balanceThe customer's current loyalty points balance. This value reflects the total points available for redemption.
balanceCashValueThe cash equivalent of the customer's current loyalty points balance, expressed in the program's base currency.
loyaltyProgramTypeThe type of loyalty program the customer is enrolled in. Typical values: 'points', 'cashback', etc.
personalCodeA unique identifier for the customer, such as a membership or personal code.
totalEarnedThe total number of loyalty points or value the customer has earned since joining the program.
totalRedeemedThe total number of loyalty points or value the customer has redeemed for rewards or benefits.
totalReservedThe total number of loyalty points or value currently reserved for pending transactions and not available for redemption.
Retrieve the transaction history for a customer by personal code.
Use this endpoint to retrieve a customer's transaction history, including all reward-related transactions. Supports pagination.
path Parameters
personalCodeThe Otonum personal code of the customer.
query Parameters
OrderByPageThe page number to retrieve. Must be greater than 0. Defaults to 1.
The page number to retrieve. Must be greater than 0. Defaults to 1.
SizeThe number of items per page. Must be greater than 0. Defaults to 10.
The number of items per page. Must be greater than 0. Defaults to 10.
Retrieve the transaction history for a customer by personal code. › Responses
Transaction history retrieved successfully.