Our leading loyalty platform is developed with an API first approach. This ensures a seamless integration into your existing IT system landscape because the relevant functionality is directly accessible via the APIs you need.

We follow OpenAPI standard guidelines and specification (RESTful APIs) for all our APIs, including detailed, interactive documentation to ensure a quick and simple integration.

Want to get access to our full API documentation?

Contact Our Loyalty Experts Today!

Loyalty Platform API Integrations by Category

A sample of our available APIs is included below – contact us to get access to the full documentation!

Loyalty api About

API Name Function Served
GET /about Returns the Prime Cloud version info.

Loyalty api Audit

API Name Function Served
GET /audits Lists the audit log history.

Deposit

API Name Function Served
GET /deposits/{key}/
statement
Points/account statement: An account statement for the account associated with the given point type is returned.
GET /deposits/{key}/
redeemable
Redeemable points balance: The redeemable points balance excludes all non-redeemable points (e.g. blocked points) from the balance. Accordingly, the API will return a balance of 0 if the account is configured to be non-redeemable (e.g. status points).
POST /deposits/{key}/
redeem
Points redemption: Redeem points from a membership account to its corresponding sponsor.
POST /deposits/{key}/
adjust
Points adjustment: Adjust points from a membership account with its corresponding sponsor.
POST /deposits/
redeem/reversal
Redemption reversal: Reverses a point redemption based on its receipt.
POST /deposits/
{sourceKey}/transfer/
{targetKey}
Points transfer: Transfers points from source membership to target membership.

Loyalty api Exports

API Name Function Served
GET /exports/templates Returns a list of all available custom templates or filter/sort the list of templates by using optional parameter.
GET /exports/{template} Creates a new data export and returns it in the specified format.

Loyalty api Imports

API Name Function Served
POST /
imports/{importType}
Queue JSON bulk import: Queues a new JSON import of a bulk of records of the specified import type.
GET /imports/report Import batches report: Returns report containing all import batches queued in the system and their status.
GET /imports/{key} Batch report with filtered records list: Returns report containing batch info with filtered records.
POST /csvimports/
{importType}
Queue CSV bulk import: Queues a new JSON import of a bulk of records of the specified import type.
GET /imports/
importtypes
Returns a list of all available import types.
GET /imports/
cancelbatch
Cancels a currently running import process.
GET /imports/
queuebatch
Queues a previous import: Marks a cancelled or failed import process for resumption.
GET /imports/
queuetype
Queues previous imports of a type: Marks cancelled or failed import processes of a specified type for resumption.

Loyalty api Membership

API Name Function Served
GET /memberships Search membership information.
POST /memberships Enroll a new membership.
GET /memberships/
{key}/accounts
Return accounts managed with membership.
GET /memberships/
{key}/details
Return membership details.
PUT /memberships/
{key}/details
Update membership details.
GET /memberships/
{userId}/legalEntity
Return legal entity information.
PUT /memberships/type/
{typeId}/legalEntity
Create or update a legal entity.
POST /memberships/
merge
Merge two memberships.
POST /memberships/
{key}/claim
Membership claim.
POST /memberships/
{userId}/legalentity/
cancel
Legal entity cancellation.
POST /memberships/
{key}/cancel
Membership cancellation.
POST /memberships/
{key}/alternateids
Add alternate Id to the membership.
DELETE /memberships/
{key}/alternateids/
{alternateId}
Delete alternate Id of the membership.
GET /memberships/
{key}/cards
Get all cards related to the membership.
GET /memberships/
{userId}/legalentity/cards
Get all cards issued to the legal entity.
PUT /memberships/
{userId}/legalentity/card
Create or update card of legal entity.
DELETE /memberships/
card/{key}
Delete card.
GET /memberships/
{key}/remarks
Get remarks of a membership.

Operations

API Name Function Served
GET /loyaltyops/
events/acknowledge
Acknowledge the reception of a list of new events with optional “limit”.
GET /loyaltyops/
events/list
Filtered list of events.

Loyalty api Promotion

API Name Function Served
GET /promos/channel/
data
List channel data.
GET /promos/product/
data
Search products information.
GET /promos/product/
{channelKey}/
{productKey}/details
Return product details.
GET /promos/program Return program info.
GET /promos/product/
categories
Get filtered list of Master Categories.
GET /promos/product/
categories/
{channelKey}
/{key}/values
Get filtered list of Category Values.
POST /promos/product/
customcategory
Sets custom category and assigns products to it.

Transaction

API Name Function Served
GET /tx Transaction history: Returns basic transaction history information that matches the provided filter criteria.
POST /tx Post a client transaction for evaluation of points earning according to promotion rules. Performs the evaluation and books the calculated points *if* a transaction Id is given (“txId”). If no txId is given, just the calculated points are returned, but no points are booked.
POST /tx/reversal Performs a reversal of transaction marked with the given receiptId.
GET /tx/{txId}/details Transaction details: Return details about the specified transaction with line items and properties.
GET /tx/rewardsHistory Transaction rewards list: Return list of transactions that were saved by TxArchiver.
GET /tx/{txId}/
rewardsDetails
Transaction rewards details: Return transaction details with the list of rewards saved by TxArchiver

Voucher

API Name Function Served
GET /voucher/types List available voucher types.
GET /voucher/{token}/
info
Return information about an issued voucher.
GET /voucher List vouchers.
POST /voucher/{type}/
issue
Issue a voucher of the given type to an optional recipient (if no recipient is given, the voucher will be marked as issued and can be converted by any member).
POST /voucher/{token}/
convert
Convert a voucher if the voucher is valid: The voucher will be validated and if it is valid, will be marked as converted.
POST /voucher/type Create a new voucher type.
POST /voucher/{token}/
revoke
Revokes a voucher from the specified recipient.

Want to See Our APIs in Action?

Request Your Personal Demo Today!

Frequently Asked Questions

Yes of course. Your IT team will love our comprehensive, interactive, and developer-friendly Loyalty API documentation. They will also love the fact that we follow OpenAPI standard guidelines and specification (RESTful APIs) for all our APIs. Simply contact us to get access to the full documentation of our Loyalty APIs!

Absolutely! The list above is just a sample of our full list of APIs which are being expanded with each release of our state-of-the-art Loyalty SaaS Platform. Simply contact us to get access to our latest API documentation!

You already have tech stack at your company – this can range from CRM-, ERP-, PMS-, CX-, BI-, eCommerce- and customer service tools, to POS software and marketing tech such as campaign management, email marketing and marketing automation. The key to success for your loyalty program is a seamless integration with all of these. And the integrations should be easy to handle for your IT team. Our SaaS Loyalty Platform based on OpenAPI standards ensures integrations will be an easy and quick task, ensuring a quick time to market and smooth operation of your loyalty program. Want to learn more? Contact our Loyalty Experts today!

Yes of course. We already have a readily available set of standard integrations to leading tools such as ERP, PMS, eCommerce, POS software, campaign management, and other marketing tools. The list of available standard integrations is expanding with each release of our state-of-the-art SaaS Loyalty Platform. Contact us to learn more!

Yes we can. Our state-of-the-art Loyalty Platform based on Open API standards has a solution for such a scenario as well. Contact our platform experts to learn more!

    Contact Us Today!

    By sending this form you confirm that you agree to the storing and processing of your personal data by Loyalty Prime as described in the Privacy Policy.

    Join International Premium Brands in their Choice for Loyalty Prime!