MOmoneyhash
v1.1

Check loyalty eligibility

Changed on

Checks whether a customer identifier is eligible to earn loyalty points for the given loyalty provider. Some providers do not support this call; in that case the response returns eligible null with a reason.

post/api/v1.4/loyalty/eligibility/

Request

  • Base URL
    https://web.moneyhash.io
  • URL
    https://web.moneyhash.io/api/v1.4/loyalty/eligibility/
  • Auth
    • API key in header X-Api-Key
    • or API key in query parameter access_token

Request body

provider_idstring required

MoneyHash loyalty service id (hashid) connected to the account.

identifierstring required

Customer identifier in the format required by identifier_type.

identifier_type'PHONE_NUMBER' | 'NATIONAL_ID' | 'EMAIL' required

How to interpret identifier (for example PHONE_NUMBER, EMAIL, etc.).

  • PHONE_NUMBER - PHONE_NUMBER
  • NATIONAL_ID - NATIONAL_ID
  • EMAIL - EMAIL

Response

eligibleboolean nullable required

Whether the customer is eligible. Null when the provider does not expose an eligibility check.

reasonstring nullable

Explanation when eligible is false or null.

Changes