Skip to main content

Change Log

17 Apr 2025​

New Features​

Added the endpoint Get customers with inactive offers by category GET <API base url>/offers/categories/inactive

10 Oct 2024​

New Features​

Changes​

registrationBonusOfferId field has been replaced by registrationBonusOfferIds in Register new Customer request

21 Aug 2024​

New Features​

12 Jun 2024​

Changes​

12 February 2024​

Changes​

07 February 2024​

Changes​

31 January 2024​

Changes​

  • Rename customer-api to customer-api-v4
  • Get Offer by id - remove unused fields likesCount, isCompleted
  • Get Merchant by id - remove unused fields from location id, email, settlement

24 January 2024​

New Features​

  • Added new field promotedCount in response of Get Offer List value.data
  • Promoted offers will always be shown first regardless of sorting in Get Offer List

11 November 2023​

New Features​

  • Added the parameter consentId in the Add New Card request

25 October 2023​

New Features​

  • Added new Authentication mechanism

14 September 2023​

  • Added new signing algorithm for authentication

New Features​

  • Added endpoint Get Program Offers GET <API base url>/offers

12 Jul 2023​

Changes​

  • Endpoint Get Customer Privilege Promo Code has been changed to
    GET <API base url>/customers/{customerId}/privilege/{privilegeId}/cards/{cardId}/promo-code
  • Response of Get Privilege List and Get Privilege by Id has been changed

Deleted​

  • Deleted the endpoint Customer Privilege Update

09 May 2023​

New Features​

  • Added the endpoint Get Privilege List
    GET <API base url>/customers/{customerId}/privileges
  • Added the endpoint Get Privilege by Id
    GET <API base url>/customers/{customerId}/privileges/{privilegeId}
  • Added the endpoint Get Customer Privilege Promo Code
    GET <API base url>/customers/{customerId}/privilege/{privilegeId}/{cardType}/promo-code

Deprecated​

  • Parameter type is deprecated and will be deleted from in the following requests:
    • Get Offer List
    • Get Offer by Id
  • Field type is deprecated and will be deleted from in the following responses:
    • Get Offer List
    • Get Offer by Id

06 Apr 2023​

New Features​

  • Added the endpoint Get Available Regions GET <API base url>/customers/{customerId}/regions
  • Added the parameter regionIds in the following requests:
    • Get Offer List
    • Get Merchant List
  • Added new fields in the following responses:
    • marketWide, regions fields in Get Offer List value.data
    • marketWide, regions fields in Get Offer by Id value
    • regions field in Get Merchant List value.data
    • regions field in Get Merchant by Id value
    • marketWide, regions fields in Get Merchant by Id value.offers.data

Deprecated​

  • Endpoint Get Available Settlements is deprecated and will be deleted
  • Parameter settlements is deprecated and will be deleted from in the following requests:
    • Get Offer List
    • Get Merchant List
  • Field settlements is deprecated and will be deleted from in the following responses:
    • Get Customer All Data
    • Get Merchant by Id
  • Field availableSettlements is deprecated and will be deleted from in the following response:
    • Get Customer All Data

27 Feb 2023​

Changes​

  • Endpoint Get PFM Stats is changed to Get PFM. New URL is GET <API base url>/customers/{id}/pfm

Deprecated​

  • Endpoint Get PFM Stats is deprecated and will be deleted as soon as all consumers migrate to a new one

31 Jan 2023​

New Features​

  • Added new field timelineType in the following request:
    • Get PFM Stats
  • Added new field categories in the following request:
    • Get PFM Stats

Changes​

  • Changed response in the following request:
    • Get PFM Stats

10 Jan 2023​

New Features​

  • Added new field ids in the following responses:
    • Get Customer All Data value.offers.reward.certificate
    • Get Customer All Data value.rewards.certificate
    • Get Offer List value.data.reward.certificate
    • Get Offer By Id value.reward.certificate
    • Get Offer By Id value.accruedRewards.certificate
    • Get Customer Reward By Id value.certificate
    • Get Merchant By Id value.offers.reward.certificate

Deprecated​

  • Field id is deprecated and will be deleted from 01 Jan 2024 in the following responses:
    • Get Customer All Data value.offers.reward.certificate
    • Get Customer All Data value.rewards.certificate
    • Get Offer List value.data.reward.certificate
    • Get Offer By Id value.reward.certificate
    • Get Offer By Id value.accruedRewards.certificate
    • Get Customer Reward By Id value.certificate
    • Get Merchant By Id value.offers.reward.certificate