API Documentation

Issue points or alternate currencies to customers

post
https://eu.api.capillarytech.com/v2/customers/bulk/manualCurrencyAllocate

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Array of manual currency allocation requests. Although the path indicates bulk, current implementation may process requests individually.

int32
required

Unique identifier of the organisation.

int32
required

Unique ID of the loyalty program.

int32
required

Unique ID for the points award strategy.

int32
required

Unique ID for the points expiry strategy.

int64 | null

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

double
required
≥ 0

Bill amount based on which points are issued.

string
enum
required

Type of event to associate with the allocation.

Allowed:
string
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.

string
enum

Type of currency being allocated.

Allowed:
string | null

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

int64 | null

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

string | null
enum

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

Allowed:
string | null
enum

Strategy for rounding the awarded points.

Allowed:
lookupParams
object
required

Object containing details of the customer.

Responses

Updated about 1 month ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago