v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Issue points or alternate currencies to customers

This API allows you to manually issue reward currency to a customer or user group.

post/v2/customers/bulk/manualCurrencyAllocate

Request body

orgIdinteger required

Unique identifier of the organisation.

programIdinteger required

Unique ID of the loyalty program.

awardStrategyIdinteger required

Unique ID for the points award strategy.

expiryStrategyIdinteger required

Unique ID for the points expiry strategy.

promotionIdinteger nullable

Unique ID of the loyalty promotion to associate with the points issue.

sourceValuenumber double required

Bill amount based on which points are issued.

eventName'TransactionAdd' | 'TargetCompleted' | 'GenericEvent' required

Type of event to associate with the allocation.

eventSourceIdstring required

Identifier related to the event. For 'TransactionAdd', this is the bill ID. For 'TargetCompleted', it can be a streak, target, or unified achieved ID. For 'GenericEvent', it's a reference ID.

currencyType'PROMISED' | 'REGULAR'

Type of currency being allocated.

alternateCurrencyIdentifierstring nullable

Identifier for the alternate currency that is generated on creation. Provide this value when issuing alternate currencies.

billLineItemIdinteger nullable

The ID of the line-item that is part of the bill.

sourceValueRoundingStrategy'FLOOR' | 'ACTUAL' | 'ROUND' nullable

Strategy for rounding the source value (total bill amount).

pointsRoundingStrategy'FLOOR' | 'ACTUAL' | 'ROUND' nullable

Strategy for rounding the awarded points.

Example request

[
  {
    "orgId": 51135,
    "programId": 2568,
    "awardStrategyId": 108865,
    "expiryStrategyId": 109345,
    "promotionId": -1,
    "sourceValue": 1000,
    "eventName": "TransactionAdd",
    "eventSourceId": "2152328861",
    "currencyType": "PROMISED"
  }
]

Response

object required