Skip to main content
API docs by Redocly

Loyalty Core Platform API (1.0)

Download OpenAPI specification:Download

Auth

AuthorizationController_authorize

Request Body schema: application/json
required
apiKey
required
string

Dev ApiKey

apiSecret
required
string

Dev ApiSecret

Responses

Request samples

Content type
application/json
{
  • "apiKey": "string",
  • "apiSecret": "string"
}

Response samples

Content type
application/json
{
  • "idToken": "18927918721892lakhjslajhsajhsksjh91827198721987219872"
}

Coupon Books

Get all the coupon books for an organization

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 25 ]
Example: limit=10

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

loyaltyProgramId
number
search
string

Case-insensitive substring match across the coupon book's name, description, and externalId.

tags
string

Filter by all of these tags (AND logic). Comma-separated.

tagsAny
string

Filter by any of these tags (OR logic). Comma-separated.

status
Array of strings
Items Enum: "draft" "published" "disabled" "archived"

The status of the coupon book. Accepts a single value or comma-separated list (e.g. 'draft,disabled').

locale
string
Deprecated

Translation locale requested for the coupon

audiences
string
locations
string
categories
string
productCategories
string
paymentMethods
string
channels
string
channelsMatch
string
Default: "effective"
Enum: "effective" "exact"

How the channels filter treats books with no channel restriction. 'effective' (default): they match. 'exact': they are excluded.

daysOfWeek
string
validFromDate
string <date-time>
validToDate
string <date-time>
validFromDateMin
string <date-time>

Admin filter: return only books whose validFromDate >= this value (future start). NULL validFromDate values are excluded.

validToDateMax
string <date-time>

Admin filter: return only books whose validToDate <= this value (already expired). Books with no validToDate are excluded.

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new coupon book

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
loyaltyProgramId
number
externalId
string
publishingStatus
required
string
Enum: "draft" "published" "disabled"

Publishing status of the coupon book

maxCouponCount
number
currentVersionId
number
name
required
string
description
string
subtitle
string
pictureUrl
string
detailPictureUrl
string
images
object
rankingIndex
number
type
required
string
Enum: "single" "list" "generated" "codeless"

Type of coupon book

discountAmount
number
discountType
string
maxAssignedPerMember
number
maxAssignedPerCoupon
number
validFromDate
string <date-time>
validToDate
string <date-time>
maxDiscountPerPeriod
number
discountPeriodType
string
Enum: "daily" "weekly" "monthly"
maxUsagesPerPeriod
number
usagePeriodType
string
Enum: "daily" "weekly" "monthly"
timezone
string
maxDiscountPerUse
number

Maximum discount amount allowed per use

assignmentRequiredPoints
number
usageRequiredPoints
number
tags
Array of strings
tiers
Array of strings
audienceKeys
Array of strings
locations
Array of strings or null

Locations for filtering coupon books by location

categories
Array of strings or null

Categories for filtering coupon books by category

productCategories
Array of strings or null

Product categories for filtering coupon books by product category

paymentMethods
Array of strings or null

Payment methods for filtering coupon books by payment method

channels
Array of strings or null

Channels for filtering coupon books by channel

daysOfWeek
Array of numbers

Days of week when coupon book is available (1=Monday, 7=Sunday)

contentSchemaId
number
contentSchemaVersionId
number
customAttributes
object
condition
object
locale
string
Deprecated

Locale

content
object
Deprecated

Content of the coupon book

isDefaultLocale
boolean
Deprecated

Is the locale default

defaultLocale
string
Deprecated

Default locale

requiredPointsConfig
required
object (RequiredPointsConfig)

Responses

Request samples

Content type
application/json
{
  • "loyaltyProgramId": 0,
  • "externalId": "string",
  • "publishingStatus": "draft",
  • "maxCouponCount": 0,
  • "currentVersionId": 0,
  • "name": "string",
  • "description": "string",
  • "subtitle": "string",
  • "pictureUrl": "string",
  • "detailPictureUrl": "string",
  • "images": { },
  • "rankingIndex": 0,
  • "type": "single",
  • "discountAmount": 0,
  • "discountType": "string",
  • "maxAssignedPerMember": 0,
  • "maxAssignedPerCoupon": 0,
  • "validFromDate": "2019-08-24T14:15:22Z",
  • "validToDate": "2019-08-24T14:15:22Z",
  • "maxDiscountPerPeriod": 0,
  • "discountPeriodType": "daily",
  • "maxUsagesPerPeriod": 0,
  • "usagePeriodType": "daily",
  • "timezone": "string",
  • "maxDiscountPerUse": 1000,
  • "assignmentRequiredPoints": 0,
  • "usageRequiredPoints": 0,
  • "tags": [
    ],
  • "tiers": [
    ],
  • "audienceKeys": [
    ],
  • "locations": [
    ],
  • "categories": [
    ],
  • "productCategories": [
    ],
  • "paymentMethods": [
    ],
  • "channels": [
    ],
  • "daysOfWeek": [
    ],
  • "contentSchemaId": 0,
  • "contentSchemaVersionId": 0,
  • "customAttributes": { },
  • "condition": { },
  • "locale": "string",
  • "content": { },
  • "isDefaultLocale": true,
  • "defaultLocale": "string",
  • "requiredPointsConfig": { }
}

Response samples

Content type
application/json
{
  • "couponBook": {
    }
}

Get an existing coupon book details

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
number

Responses

Response samples

Content type
application/json
{
  • "couponBook": {
    }
}

Updates an existing coupon book

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
number
Request Body schema: application/json
required
loyaltyProgramId
number
externalId
string
maxCouponCount
number
currentVersionId
number
description
string
subtitle
string
pictureUrl
string
detailPictureUrl
string
images
object
rankingIndex
number
discountAmount
number
discountType
string
maxAssignedPerMember
number
maxAssignedPerCoupon
number
validFromDate
string <date-time>
validToDate
string <date-time>
maxDiscountPerPeriod
number
discountPeriodType
string
Enum: "daily" "weekly" "monthly"
maxUsagesPerPeriod
number
usagePeriodType
string
Enum: "daily" "weekly" "monthly"
timezone
string
maxDiscountPerUse
number

Maximum discount amount allowed per use

assignmentRequiredPoints
number
usageRequiredPoints
number
tags
Array of strings
tiers
Array of strings
audienceKeys
Array of strings
locations
Array of strings or null

Locations for filtering coupon books by location

categories
Array of strings or null

Categories for filtering coupon books by category

productCategories
Array of strings or null

Product categories for filtering coupon books by product category

paymentMethods
Array of strings or null

Payment methods for filtering coupon books by payment method

channels
Array of strings or null

Channels for filtering coupon books by channel

daysOfWeek
Array of numbers

Days of week when coupon book is available (1=Monday, 7=Sunday)

contentSchemaId
number
contentSchemaVersionId
number
customAttributes
object
condition
object
locale
string
Deprecated

Locale

content
object
Deprecated

Content of the coupon book

isDefaultLocale
boolean
Deprecated

Is the locale default

defaultLocale
string
Deprecated

Default locale

requiredPointsConfig
required
object (RequiredPointsConfig)
name
string

The name of the coupon book

extraFields
object

content extra fields

Responses

Request samples

Content type
application/json
{
  • "loyaltyProgramId": 0,
  • "externalId": "string",
  • "maxCouponCount": 0,
  • "currentVersionId": 0,
  • "description": "string",
  • "subtitle": "string",
  • "pictureUrl": "string",
  • "detailPictureUrl": "string",
  • "images": { },
  • "rankingIndex": 0,
  • "discountAmount": 0,
  • "discountType": "string",
  • "maxAssignedPerMember": 0,
  • "maxAssignedPerCoupon": 0,
  • "validFromDate": "2019-08-24T14:15:22Z",
  • "validToDate": "2019-08-24T14:15:22Z",
  • "maxDiscountPerPeriod": 0,
  • "discountPeriodType": "daily",
  • "maxUsagesPerPeriod": 0,
  • "usagePeriodType": "daily",
  • "timezone": "string",
  • "maxDiscountPerUse": 1000,
  • "assignmentRequiredPoints": 0,
  • "usageRequiredPoints": 0,
  • "tags": [
    ],
  • "tiers": [
    ],
  • "audienceKeys": [
    ],
  • "locations": [
    ],
  • "categories": [
    ],
  • "productCategories": [
    ],
  • "paymentMethods": [
    ],
  • "channels": [
    ],
  • "daysOfWeek": [
    ],
  • "contentSchemaId": 0,
  • "contentSchemaVersionId": 0,
  • "customAttributes": { },
  • "condition": { },
  • "locale": "string",
  • "content": { },
  • "isDefaultLocale": true,
  • "defaultLocale": "string",
  • "requiredPointsConfig": { },
  • "name": "string",
  • "extraFields": { }
}

Response samples

Content type
application/json
{
  • "couponBook": {
    }
}

Use a coupon from the coupon book

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
string
Request Body schema: application/json
required
systemUniqueKey
string

System Unique Key by Organization ID

customAttributes
object
memberId
required
number
code
string

Code to be used

pendingCaptureLedgerTransactionId
string

Ledger transaction ID

externalId
string

External ID for tracking

pointsOverride
number

Optional points override. Positive values burn points, negative values mint points, zero skips point transaction. When absent, uses coupon book configured points.

Responses

Request samples

Content type
application/json
{
  • "systemUniqueKey": "string",
  • "customAttributes": {
    },
  • "memberId": 0,
  • "code": "string",
  • "pendingCaptureLedgerTransactionId": "1234",
  • "externalId": "ext-123",
  • "pointsOverride": 100
}

Response samples

Content type
application/json
{
  • "couponUsages": [
    ]
}

Assign a coupon from the coupon book

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
string
Request Body schema: application/json
required
systemUniqueKeys
Array of strings

System Unique Key by Organization ID

customAttributes
object
memberId
required
number
numberOfCodes
object
Default: 1

Number of codes to use

amount
object
Default: 1

Amount to be assigned for each code

codes
Array of strings

Codes to be assigned

strictMode
boolean
Default: false

Strict mode gets the exact number of codes or fails

expiredAt
string <date-time>

Expiration date for the assigned codes

pendingCaptureLedgerTransactionId
string

Ledger transaction ID

externalId
string

External ID for tracking

pointsOverride
number

Optional points override. Positive values burn points, negative values mint points, zero skips point transaction. When absent, uses coupon book configured points.

Responses

Request samples

Content type
application/json
{
  • "systemUniqueKeys": [
    ],
  • "customAttributes": {
    },
  • "memberId": 0,
  • "numberOfCodes": 1,
  • "amount": 1,
  • "codes": [
    ],
  • "strictMode": false,
  • "expiredAt": "2019-08-24T14:15:22Z",
  • "pendingCaptureLedgerTransactionId": "1234",
  • "externalId": "ext-456",
  • "pointsOverride": 50
}

Response samples

Content type
application/json
{
  • "couponUsages": [
    ]
}

Assign a coupon from the coupon book to a batch of members

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
string
Request Body schema: application/json
required
required
Array of objects (BatchAssignItemDto)

Members to assign a coupon to (1-100).

pointsOverride
number

Optional points override applied to every member in the batch. Positive values burn points, negative values mint points, zero skips the point transaction. When absent, uses coupon book configured points.

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "pointsOverride": 0
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "successCount": 0,
  • "failureCount": 0,
  • "totalAttempted": 0
}

Revert a coupon usage

Authorizations:
bearer
path Parameters
organizationId
required
number
couponUsageId
required
number
Request Body schema: application/json
required
forceRevert
boolean
Default: false

Skip validation that prevents reverting assignments when usedBalance would exceed assignedBalance

Responses

Request samples

Content type
application/json
{
  • "forceRevert": false
}

Response samples

Content type
application/json
{
  • "couponUsages": [
    ]
}

Get all the coupon codes in a coupon books for an organization

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 25 ]
Example: limit=10

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Adds a new coupons to the coupon-book

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
number
Request Body schema: application/json
required
codes
required
Array of strings

Codes to be added

Responses

Request samples

Content type
application/json
{
  • "codes": [
    ]
}

Response samples

Content type
application/json
{
  • "codes": [
    ]
}

Get an existing coupon book code details

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
number
couponId
required
number

Responses

Response samples

Content type
application/json
{
  • "couponCode": {
    }
}

Updates an existing coupon

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
number
couponId
required
number
Request Body schema: application/json
required
code
required
string

Code to be updated

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "couponBook": {
    }
}

Use the specified coupon from the coupon-book

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
number
couponId
required
number
Request Body schema: application/json
required
systemUniqueKey
string

System Unique Key by Organization ID

customAttributes
object
memberId
required
number
pendingCaptureLedgerTransactionId
string

Ledger transaction ID

externalId
string

External ID for tracking

pointsOverride
number

Optional points override. Positive values burn points, negative values mint points, zero skips point transaction. When absent, uses coupon book configured points.

Responses

Request samples

Content type
application/json
{
  • "systemUniqueKey": "string",
  • "customAttributes": {
    },
  • "memberId": 0,
  • "pendingCaptureLedgerTransactionId": "1234",
  • "externalId": "ext-123",
  • "pointsOverride": 100
}

Response samples

Content type
application/json
{
  • "couponUsage": {
    }
}

Assign the specified coupon from the coupon-book

Authorizations:
bearer
path Parameters
organizationId
required
number
couponBookId
required
number
couponId
required
number
Request Body schema: application/json
required
customAttributes
object
memberId
required
number
amount
object
Default: 1

Amount to be assigned for each code

strictMode
boolean
Default: false

Strict mode gets the exact number of codes or fails

pendingCaptureLedgerTransactionId
string

Ledger transaction ID

externalId
string

External ID for tracking

pointsOverride
number

Optional points override. Positive values burn points, negative values mint points, zero skips point transaction. When absent, uses coupon book configured points.

systemUniqueKey
string

System Unique Key by Organization ID

Responses

Request samples

Content type
application/json
{
  • "customAttributes": {
    },
  • "memberId": 0,
  • "amount": 1,
  • "strictMode": false,
  • "pendingCaptureLedgerTransactionId": "1234",
  • "externalId": "ext-456",
  • "pointsOverride": 50,
  • "systemUniqueKey": "string"
}

Response samples

Content type
application/json
{
  • "couponUsages": [
    ]
}

Benefits Organization Members

Get all the coupon books from a member ID

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyProgramId
required
number
memberId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 25 ]
Example: limit=10

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

tags
string

Filter by all of these tags (AND logic). Comma-separated.

tagsAny
string

Filter by any of these tags (OR logic). Comma-separated.

couponBookId
number
validFromDate
string <date-time>
validToDate
string <date-time>
tiers
number
audiences
string
outOfStock
boolean
includeLastUsage
boolean
locale
string
Deprecated

Translation locale requested for the coupon

locations
string
categories
string
productCategories
string
paymentMethods
string
channels
string
channelsMatch
string
Default: "effective"
Enum: "effective" "exact"

How the channels filter treats books with no channel restriction. 'effective' (default): they match. 'exact': they are excluded.

daysOfWeek
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Get all the coupons from a member ID

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyProgramId
required
number
memberId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 25 ]
Example: limit=10

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

couponBookId
number
notUsedOnly
boolean
couponBookTags
string

Filter by coupon books with all of these tags (AND logic). Comma-separated.

couponBookTagsAny
string

Filter by coupon books with any of these tags (OR logic). Comma-separated.

couponCodeId
number
couponCode
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Get all the coupons usages count from a member ID

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyProgramId
required
number
memberId
required
number
query Parameters
validFromDate
string <date-time>
validToDate
string <date-time>
tags
string

Filter by all of these tags (AND logic). Comma-separated.

tagsAny
string

Filter by any of these tags (OR logic). Comma-separated.

Responses

Response samples

Content type
application/json
{
  • "amountUsed": 0,
  • "amountAssigned": 0
}

Member Badges

Get a member's badge balance

Authorizations:
bearer
path Parameters
organizationId
required
number
memberIdentifier
required
string
badgeIdentifier
required
string

Responses

Response samples

Content type
application/json
{
  • "balance": {
    }
}

Assign a badge to a member

Authorizations:
bearer
path Parameters
organizationId
required
number
memberIdentifier
required
string
badgeIdentifier
required
string
Request Body schema: application/json
required
amount
number >= 1
Default: 1

Amount to assign

systemUniqueKey
string

System unique key for idempotency

customAttributes
object

Custom attributes

externalId
string

External ID for tracking

Responses

Request samples

Content type
application/json
{
  • "amount": 1,
  • "systemUniqueKey": "string",
  • "customAttributes": { },
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "badgeTracking": {
    }
}

Unassign a badge from a member

Authorizations:
bearer
path Parameters
organizationId
required
number
memberIdentifier
required
string
badgeIdentifier
required
string
Request Body schema: application/json
required
amount
number >= 1
Default: 1

Amount to unassign

systemUniqueKey
string

System unique key for idempotency

customAttributes
object

Custom attributes

externalId
string

External ID for tracking

Responses

Request samples

Content type
application/json
{
  • "amount": 1,
  • "systemUniqueKey": "string",
  • "customAttributes": { },
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "badgeTracking": {
    }
}

Revert a badge assignment

Authorizations:
bearer
path Parameters
organizationId
required
number
memberIdentifier
required
string
badgeTrackingIdentifier
required
string

Responses

Response samples

Content type
application/json
{
  • "badgeTracking": {
    }
}

Action Matchers

Get all the matchers for an organization

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

type
string
Value: "item-matcher"
matcherKey
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new matcher

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
organizationId
number
name
required
string
type
required
string
Value: "item-matcher"
matcher
required
object

Responses

Request samples

Content type
application/json
{
  • "organizationId": 0,
  • "name": "string",
  • "type": "item-matcher",
  • "matcher": { }
}

Response samples

Content type
application/json
{
  • "organizationId": 0,
  • "name": "string",
  • "type": "item-matcher",
  • "matcher": { }
}

Get an existing macther details

Authorizations:
bearer
path Parameters
organizationId
required
number
matcherId
required
string

Responses

Response samples

Content type
application/json
{
  • "matcher": {
    }
}

Updates an existing matcher

Authorizations:
bearer
path Parameters
organizationId
required
number
matcherId
required
number
Request Body schema: application/json
required
organizationId
number
name
required
string
type
required
string
Value: "item-matcher"
matcher
required
object

Responses

Request samples

Content type
application/json
{
  • "organizationId": 0,
  • "name": "string",
  • "type": "item-matcher",
  • "matcher": { }
}

Response samples

Content type
application/json
{
  • "matcher": {
    }
}

Get an existing matcher details by key

Authorizations:
bearer
path Parameters
organizationId
required
number
matcherKey
required
string

Responses

Response samples

Content type
application/json
{
  • "matcher": {
    }
}

Rules Effects

Get all the effects for an organization

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Get an existing effect details

Authorizations:
bearer
path Parameters
organizationId
required
number
effectId
required
string

Responses

Response samples

Content type
application/json
{
  • "effect": {
    }
}

Loyalty Events

Tracks a loyalty event

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
systemUniqueKey
required
string [ 3 .. 255 ] characters

The unique key of the event

externalId
string [ 3 .. 255 ] characters

The external id of the event

memberId
required
number >= 1

The member Id

eventType
required
string >= 3 characters

The type of the event

description
string

The description of the event

payload
object

The payload of the event

organizationId
required
number >= 1

The organization Id

externalEventDate
string <date-time>

The date the event was created

tags
Array of strings

The tags of the event

Responses

Request samples

Content type
application/json
{
  • "systemUniqueKey": "string",
  • "externalId": "string",
  • "memberId": 1,
  • "eventType": "string",
  • "description": "string",
  • "payload": { },
  • "organizationId": 1,
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "systemUniqueKey": "string",
  • "effects": [
    ]
}

Gets all loyalty event types

Authorizations:
bearer
path Parameters
organizationId
required
number

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new loyalty event type

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
name
required
string
customAttributes
object
description
string
active
boolean
schemaType
required
string
Enum: "builtin" "string" "number" "url" "custom"

The type of schema that this event type uses.

apiCode
required
string [ 1 .. 255 ] characters /^[a-z0-9\-_.]+$/

Unique identifier within the organization. Must be non-empty and contain only lowercase alphanumeric characters, hyphens, underscores, and periods.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "customAttributes": { },
  • "description": "string",
  • "active": true,
  • "schemaType": "builtin",
  • "apiCode": "app-install"
}

Response samples

Content type
application/json
{
  • "eventType": {
    }
}

Creates a new loyalty event type

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
name
required
string
customAttributes
object
description
string
active
boolean
schemaType
required
string
Enum: "builtin" "string" "number" "url" "custom"

The type of schema that this event type uses.

apiCode
required
string [ 1 .. 255 ] characters /^[a-z0-9\-_.]+$/

Unique identifier within the organization. Must be non-empty and contain only lowercase alphanumeric characters, hyphens, underscores, and periods.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "customAttributes": { },
  • "description": "string",
  • "active": true,
  • "schemaType": "builtin",
  • "apiCode": "app-install"
}

Response samples

Content type
application/json
{
  • "eventType": {
    }
}

Gets a loyalty event type by its api code

Authorizations:
bearer
path Parameters
organizationId
required
number
apiCode
required
string

Responses

Response samples

Content type
application/json
{
  • "eventType": {
    }
}

Event triggers

LoyaltyEventTriggerController_findAll

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

type
string
Enum: "WebHook" "EntityChangeWebhook" "AsyncTrackWebhook"
active
boolean
name
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

LoyaltyEventTriggerController_create

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
triggerKey
required
string
type
required
string
Enum: "WebHook" "EntityChangeWebhook" "AsyncTrackWebhook"
name
required
string
settings
required
object
active
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "trigger": {
    }
}

LoyaltyEventTriggerController_findOne

Authorizations:
bearer
path Parameters
organizationId
required
number
triggerId
required
number

Responses

Response samples

Content type
application/json
{
  • "trigger": {
    }
}

LoyaltyEventTriggerController_update

Authorizations:
bearer
path Parameters
organizationId
required
number
triggerId
required
number
Request Body schema: application/json
required
triggerKey
required
string
type
required
string
Enum: "WebHook" "EntityChangeWebhook" "AsyncTrackWebhook"
name
required
string
settings
required
object
active
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "trigger": {
    }
}

Member Purchase Orders

Imports new Purchase Orders for Loyalty Members

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
required
Array of objects (CreateLoyaltyMemberPurchaseOrderDto)
Array
externalEventDate
string <date-time>
externalId
required
string
description
string
loyaltyProgramId
number
customAttributes
object
type
required
string
tags
Array of strings
total
required
number
discountedTotal
number
subTotal
number
merchantId
string
paymentMethod
string
locationCode
string
referralCode
string
channel
string
coupons
object
status
required
string
Enum: "created" "confirmed" "cancelled" "rejected" "returned" "partially-returned"
Array of objects (CreateMemberPurchaseOrderItemDto)
loyaltyMemberId
required
string

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List Purchase Orders

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Updates or Create a new Purchase Order

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number
Request Body schema: application/json
required
externalEventDate
string <date-time>
externalId
required
string
description
string
loyaltyProgramId
number
customAttributes
object
type
required
string
tags
Array of strings
total
required
number
discountedTotal
number
subTotal
number
merchantId
string
paymentMethod
string
locationCode
string
referralCode
string
channel
string
coupons
object
status
required
string
Enum: "created" "confirmed" "cancelled" "rejected" "returned" "partially-returned"
Array of objects (CreateMemberPurchaseOrderItemDto)

Responses

Request samples

Content type
application/json
{
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "description": "string",
  • "loyaltyProgramId": 0,
  • "customAttributes": { },
  • "type": "string",
  • "tags": [
    ],
  • "total": 0,
  • "discountedTotal": 0,
  • "subTotal": 0,
  • "merchantId": "string",
  • "paymentMethod": "string",
  • "locationCode": "string",
  • "referralCode": "string",
  • "channel": "string",
  • "coupons": { },
  • "status": "created",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "order": {
    },
  • "evaluationResults": {
    }
}

Gets a Single Purchase Order details

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number
orderId
required
number

Responses

Response samples

Content type
application/json
{
  • "order": {
    }
}

Member Events

Gets members events

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 25 ]
Example: limit=25

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

fromCreatedAt
string <date-time>

Filter events created from this date

toCreatedAt
string <date-time>

Filter events created up to this date

eventType
string
Enum: "member-purchase-order-created" "member-purchase-order-confirmed" "member-purchase-order-cancelled" "member-purchase-order-rejected" "member-purchase-order-returned" "member-purchase-order-partially-returned" "member-created" "member-updated" "member-profile-completed" "member-tier-set" "member-tier-removed" "member-profile-deactivated" "member-generic-event" "benefit-used" "coupon-code-assigned" "coupon-code-used" "badge-assigned" "badge-unassigned" "mission-status-updated" "ledger-transaction-created" "member-payment-confirmed"

Filter events by type

status
string
Enum: "pending" "running" "failed" "success"

Filter events by status

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Missions

MissionController_findAll

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

loyaltyProgramId
number >= 1

The loyalty program id

type
string
codes
string
tags
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

MissionController_create

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
loyaltyProgramId
required
number
name
required
string
shortDescription
string
description
string
pictureUrl
string
customAttributes
object
type
string
audienceId
number
tags
Array of strings
code
required
string
active
boolean
validFrom
string <date-time>
validTo
string <date-time>
repetitionPeriod
string
periodLimit
number
pointsAccrual
number
ledgerId
number
ledgerAccountId
number
couponBookKey
string
badgeKey
string

Badge key to assign to the member when the mission is achieved

ledgerTransactionDescription
string

Custom ledger transaction description used when mission accrues points

Array of strings or InlineMatcherDto (any)

Inline matcher. Can be a simple array of category codes (e.g. ['bebidas', 'snacks']) which means at least 1 of each (AND), or a full object with operator and conditions. Cannot be used together with matcherId.

object

Badge matcher. Only supported for badge-assigned / badge-unassigned event types. Defines badge balance conditions combined with AND/OR. Cannot be used together with matcherId or inlineMatcher.

minSpendValue
number >= 0

Minimum order total (payload.total) required for an event to count towards mission progress. Only supported for purchase-order and member-payment-confirmed event types. Matches the minSpendValue filter on smart campaigns.

object

Optional manual expiration applied to every mint produced by the mission's points reward. Same shape and semantics as the campaign-level manualExpiration: { value: positive integer, unit: 'days' | 'weeks' | 'months' }. Only valid when pointsAccrual > 0 (rejected with 400 otherwise); the target ledger account must have pointTrackingEnabled = true.

eventType
required
string <= 255 characters

Event Type to match. Accepts built-in event types (e.g. member-purchase-order-confirmed) and organization-scoped custom event apiCodes.

maxRepetitions
required
number >= 1

Max number of repetitions

goalCount
required
number >= 1

Goal count

matcherId
number >= 1

Related matcher id

Responses

Request samples

Content type
application/json
{
  • "loyaltyProgramId": 0,
  • "name": "string",
  • "shortDescription": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "customAttributes": { },
  • "type": "string",
  • "audienceId": 0,
  • "tags": [
    ],
  • "code": "string",
  • "active": true,
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "repetitionPeriod": "string",
  • "periodLimit": 0,
  • "pointsAccrual": 0,
  • "ledgerId": 0,
  • "ledgerAccountId": 0,
  • "couponBookKey": "string",
  • "badgeKey": "string",
  • "ledgerTransactionDescription": "string",
  • "inlineMatcher": [
    ],
  • "badgeMatcher": {
    },
  • "minSpendValue": 50,
  • "manualExpiration": {
    },
  • "eventType": "member-purchase-order-confirmed",
  • "maxRepetitions": 10,
  • "goalCount": 3,
  • "matcherId": 1
}

Response samples

Content type
application/json
{
  • "mission": {
    }
}

MissionController_findOne

Authorizations:
bearer
path Parameters
organizationId
required
number
missionId
required
number

Responses

Response samples

Content type
application/json
{
  • "mission": {
    }
}

MissionController_update

Authorizations:
bearer
path Parameters
organizationId
required
number
missionId
required
number
Request Body schema: application/json
required
loyaltyProgramId
required
number
name
required
string
shortDescription
string
description
string
pictureUrl
string
customAttributes
object
type
string
audienceId
number
tags
Array of strings
code
required
string
active
boolean
validFrom
string <date-time>
validTo
string <date-time>
pointsAccrual
number
ledgerId
number
ledgerAccountId
number
couponBookKey
string
badgeKey
string

Badge key to assign to the member when the mission is achieved

ledgerTransactionDescription
string

Custom ledger transaction description used when mission accrues points

Array of strings or InlineMatcherDto (any)

Inline matcher. Can be a simple array of category codes (e.g. ['bebidas', 'snacks']) which means at least 1 of each (AND), or a full object with operator and conditions. Cannot be used together with matcherId.

object

Badge matcher. Only supported for badge-assigned / badge-unassigned event types. Defines badge balance conditions combined with AND/OR. Cannot be used together with matcherId or inlineMatcher.

minSpendValue
number >= 0

Minimum order total (payload.total) required for an event to count towards mission progress. Only supported for purchase-order and member-payment-confirmed event types. Matches the minSpendValue filter on smart campaigns.

object

Optional manual expiration applied to every mint produced by the mission's points reward. Same shape and semantics as the campaign-level manualExpiration: { value: positive integer, unit: 'days' | 'weeks' | 'months' }. Only valid when pointsAccrual > 0 (rejected with 400 otherwise); the target ledger account must have pointTrackingEnabled = true.

eventType
required
string <= 255 characters

Event Type to match. Accepts built-in event types (e.g. member-purchase-order-confirmed) and organization-scoped custom event apiCodes.

maxRepetitions
required
number >= 1

Max number of repetitions

goalCount
required
number >= 1

Goal count

matcherId
number >= 1

Related matcher id

Responses

Request samples

Content type
application/json
{
  • "loyaltyProgramId": 0,
  • "name": "string",
  • "shortDescription": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "customAttributes": { },
  • "type": "string",
  • "audienceId": 0,
  • "tags": [
    ],
  • "code": "string",
  • "active": true,
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "pointsAccrual": 0,
  • "ledgerId": 0,
  • "ledgerAccountId": 0,
  • "couponBookKey": "string",
  • "badgeKey": "string",
  • "ledgerTransactionDescription": "string",
  • "inlineMatcher": [
    ],
  • "badgeMatcher": {
    },
  • "minSpendValue": 50,
  • "manualExpiration": {
    },
  • "eventType": "member-purchase-order-confirmed",
  • "maxRepetitions": 10,
  • "goalCount": 3,
  • "matcherId": 1
}

Response samples

Content type
application/json
{
  • "mission": {
    }
}

Organization Members

Gets organization's members details

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 25 ]
Example: limit=25

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

email
string

Filter by email

loyaltyMemberId
string

Filter by loyalty member id

govId
string

Filter by government id (matches the id inside the gov_id field)

walletId
number >= 1

Optional Wallet Id

fromCreatedAt
string <date-time>

Filter members created from this date

toCreatedAt
string <date-time>

Filter members created up to this date

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new Member in the current organization

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
loyaltyMemberId
required
string

Loyalty Member Id within Organization and Loyalty Program

memberType
string

Type of the member.

channelAcquisition
string

Source of the member.

publicLoyaltyMemberId
string

Optional Public Loyalty Member Id within Organization and Loyalty Program

object

Member's Onchain Info.

object

Member's Profile Info.

customAttributes
object

Custom dynamic attributes for organization member.

active
boolean
referralCode
string

An Optional Referral Code

notifications
object

Notification preferences

Responses

Request samples

Content type
application/json
{
  • "loyaltyMemberId": "11111-11111",
  • "memberType": "organization",
  • "channelAcquisition": "mobile_app",
  • "publicLoyaltyMemberId": "11111-11111",
  • "onChain": {
    },
  • "profile": {
    },
  • "customAttributes": {
    },
  • "active": true,
  • "referralCode": "test@email.com",
  • "notifications": {
    }
}

Response samples

Content type
application/json
{
  • "loyalMember": {
    }
}

Get members by batch

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
memberIds
required
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "memberIds": [
    ]
}

Response samples

Content type
application/json
{
  • "members": [
    ],
  • "notFound": [
    ]
}

Gets organization's Member details

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number

Responses

Response samples

Content type
application/json
{
  • "loyalMember": {
    }
}

Updates a existing Member details

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number
Request Body schema: application/json
required
object

Member's Onchain Info.

object

Member's Profile Info.

customAttributes
object

Custom dynamic attributes for organization member.

active
boolean
publicLoyaltyMemberId
string

Optional Public Loyalty Member Id within Organization and Loyalty Program

loyaltyMemberId
string

Loyalty Member Id within Organization and Loyalty Program

memberType
string

Type of the member.

channelAcquisition
string

Source of the member.

notifications
object

Notification preferences

updateReason
string

Reason for updating the member

emitEvent
boolean
Default: true

If true (default), pushes a MemberUpdated loyalty event onto SQS so event triggers and downstream consumers react to this update. Set to false to suppress the event — for back-office or migration writes that should not fan out. The DB audit log is written regardless.

Responses

Request samples

Content type
application/json
{
  • "onChain": {
    },
  • "profile": {
    },
  • "customAttributes": {
    },
  • "active": true,
  • "publicLoyaltyMemberId": "11111-11111",
  • "loyaltyMemberId": "11111-11111",
  • "memberType": "organization",
  • "channelAcquisition": "mobile_app",
  • "notifications": {
    },
  • "updateReason": "Updated member profile information",
  • "emitEvent": true
}

Response samples

Content type
application/json
{
  • "loyalMember": {
    }
}

Sets Member's Loyalty Tier for Program

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number
loyaltyProgramId
required
number
Request Body schema: application/json
required
loyaltyTierId
number >= 1

The ID of the loyalty tier. If not specified, tier is unassigned

expiresAt
string <date-time>

Optional Expiration Date of the Tier. At that expiration Tier will be re-evaluated.

externalId
string

The ID of the external event

systemUniqueKey
string

A unique key for the system

description
string

Description associated with the tier change

tags
Array of strings

Tags associated with the tier change

Responses

Request samples

Content type
application/json
{
  • "loyaltyTierId": 1,
  • "expiresAt": "2027-02-26T02:18:13.117Z",
  • "externalId": "string",
  • "systemUniqueKey": "string",
  • "description": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "loyaltyTierId": 1,
  • "memberTierTrackingId": 0
}

Removes Member from Loyalty Program

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number
loyaltyProgramId
required
number

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Get Member's Loyalty Tier History for Program

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number
loyaltyProgramId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Get member's missions and status

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

loyaltyProgramId
number >= 1

The loyalty program id

type
string
codes
string
tags
string
minTimesAchieved
number >= 0

Min number of times it has been achieved

minCounterCount
number >= 0

Min number of times the event has been triggered

available
boolean

Filter available missions

inProgress
boolean

If member started the mission but has not achieved it yet (even if she completed it in the past)

active
boolean

Filter missions with active status

validFrom
string <date-time>

Filter missions with valid from date

validTo
string <date-time>

Filter missions with valid to date

missionKey
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Increment member's mission counter

Authorizations:
bearer
path Parameters
organizationId
required
number
memberId
required
number
missionId
required
number
Request Body schema: application/json
required
amount
required
number >= 0
systemUniqueKey
string
externalId
string
tags
Array of strings
description
string
externalEventDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "systemUniqueKey": "string",
  • "externalId": "string",
  • "tags": [
    ],
  • "description": "string",
  • "externalEventDate": "2024-08-01T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "balance": {
    }
}

Rules Expressions

Parse string expressions to AST Expression Node

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
required
Array of objects (ParseRequestInputDto)

The expressions to parse.

annotate
boolean

Whether to annotate the AST.

Responses

Request samples

Content type
application/json
{
  • "inputs": [
    ],
  • "annotate": true
}

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

Convert AST nodes to expressions

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
required
Array of objects (AST2ExpressionInputDto)

The AST nodes.

annotate
boolean

Whether to annotate the AST.

Responses

Request samples

Content type
application/json
{
  • "inputs": [
    ],
  • "annotate": true
}

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

Organization Loyalty Members

Gets organization's Loyalty Member details

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyMemberId
required
string
query Parameters
includeBalance
boolean
Default: true

When false, skips the wallet-balance lookup and returns the member without ledger balances. Defaults to true.

Responses

Response samples

Content type
application/json
{
  • "loyalMember": {
    }
}

Sets organization's Loyalty Member tier

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyMemberId
required
string
Request Body schema: application/json
required
loyaltyTierId
number >= 1

The ID of the loyalty tier. If not specified, tier is unassigned

expiresAt
string <date-time>

Optional Expiration Date of the Tier. At that expiration Tier will be re-evaluated.

externalId
string

The ID of the external event

systemUniqueKey
string

A unique key for the system

description
string

Description associated with the tier change

tags
Array of strings

Tags associated with the tier change

loyaltyProgramId
required
number

The ID of the loyalty program

Responses

Request samples

Content type
application/json
{
  • "loyaltyTierId": 1,
  • "expiresAt": "2027-02-26T02:18:13.117Z",
  • "externalId": "string",
  • "systemUniqueKey": "string",
  • "description": "string",
  • "tags": [
    ],
  • "loyaltyProgramId": 0
}

Response samples

Content type
application/json
{
  • "loyaltyTierId": 1,
  • "memberTierTrackingId": 0
}

Get all matching audiences for a member

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyMemberId
required
string

Responses

Response samples

Content type
application/json
{
  • "audiences": [
    ]
}

Check matching audience for a member

Authorizations:
bearer
path Parameters
loyaltyMemberId
required
string
audienceId
required
number
organizationId
required
number

Responses

Response samples

Content type
application/json
{
  • "match": true
}

Mints loyalty points to organization's Loyalty Member

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyMemberId
required
string
Request Body schema: application/json
required
ledgerId
number

The ID of the ledger. If not specified, default ledger for organization is resolved.

ledgerAccountId
number

The ID of the ledger account. If not specified, default ledger and ledger account for organization is resolved.

amount
required
number >= 0

The amount to mint or burn

description
string

The description of the mint/burn operation

tags
Array of strings

Tags associated with the mint/burn operation

systemUniqueKey
string

A unique key for the system

externalEventDate
string <date-time>

The date of the external event

externalId
string

The ID of the external event

Responses

Request samples

Content type
application/json
{
  • "ledgerId": 0,
  • "ledgerAccountId": 0,
  • "amount": 0,
  • "description": "string",
  • "tags": [
    ],
  • "systemUniqueKey": "string",
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "ledgerTransactions": [
    ]
}

Burns loyalty points to organization's Loyalty Member

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyMemberId
required
string
Request Body schema: application/json
required
ledgerId
number

The ID of the ledger. If not specified, default ledger for organization is resolved.

ledgerAccountId
number

The ID of the ledger account. If not specified, default ledger and ledger account for organization is resolved.

amount
required
number >= 0

The amount to mint or burn

description
string

The description of the mint/burn operation

tags
Array of strings

Tags associated with the mint/burn operation

systemUniqueKey
string

A unique key for the system

externalEventDate
string <date-time>

The date of the external event

externalId
string

The ID of the external event

Responses

Request samples

Content type
application/json
{
  • "ledgerId": 0,
  • "ledgerAccountId": 0,
  • "amount": 0,
  • "description": "string",
  • "tags": [
    ],
  • "systemUniqueKey": "string",
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "ledgerTransactions": [
    ]
}

Referrals

ReferralsController_create

Authorizations:
bearer
path Parameters
organizationId
required
number
referralProgramId
required
number
Request Body schema: application/json
required
memberId
required
number

ID of the member referring the new member

codes
required
Array of strings[ items ]

Responses

Request samples

Content type
application/json
{
  • "memberId": 111,
  • "codes": [
    ]
}

Response samples

Content type
application/json
{
  • "referrals": [
    ]
}

ReferralsController_findAllReferralCodes

Authorizations:
bearer
path Parameters
organizationId
required
number
referralProgramId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

memberId
number
Example: memberId=111

ID of the member whose referral codes are being requested

Responses

Response samples

Content type
application/json
{
  • "referrals": [
    ]
}

ReferralsController_findAllReferred

Authorizations:
bearer
path Parameters
organizationId
required
number
referralProgramId
required
number
referralCodeId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

ReferralsProgramController_findAll

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

ReferralsProgramController_create

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
loyaltyProgramId
number
name
required
string
description
string
pictureUrl
string
customAttributes
object
active
required
boolean
validFromDate
string <date-time>
validToDate
string <date-time>
maxPerCode
required
number
maxReferralsPerMember
required
number
Default: 9007199254740991

The maximum number of referrals per member

maxRedeemsPerReferredMemberPerCode
number
audienceId
number
tags
Array of strings
code
required
string
eventType
required
string
referrerPointsAccrual
number
referrerLedgerId
number
referrerLedgerAccountId
number
referredPointsAccrual
number
referredLedgerId
number
referredLedgerAccountId
number
referredCount
number
referrerCouponBookKey
string
referredCouponBookKey
string

Responses

Request samples

Content type
application/json
{
  • "loyaltyProgramId": 0,
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "customAttributes": { },
  • "active": true,
  • "validFromDate": "2019-08-24T14:15:22Z",
  • "validToDate": "2019-08-24T14:15:22Z",
  • "maxPerCode": 0,
  • "maxReferralsPerMember": 10,
  • "maxRedeemsPerReferredMemberPerCode": 0,
  • "audienceId": 0,
  • "tags": [
    ],
  • "code": "string",
  • "eventType": "string",
  • "referrerPointsAccrual": 0,
  • "referrerLedgerId": 0,
  • "referrerLedgerAccountId": 0,
  • "referredPointsAccrual": 0,
  • "referredLedgerId": 0,
  • "referredLedgerAccountId": 0,
  • "referredCount": 0,
  • "referrerCouponBookKey": "string",
  • "referredCouponBookKey": "string"
}

Response samples

Content type
application/json
{
  • "referralProgram": {
    }
}

ReferralsProgramController_findOne

Authorizations:
bearer
path Parameters
organizationId
required
number
referralProgramId
required
number

Responses

Response samples

Content type
application/json
{
  • "referralProgram": {
    }
}

ReferralsProgramController_update

Authorizations:
bearer
path Parameters
organizationId
required
number
referralProgramId
required
number
Request Body schema: application/json
required
loyaltyProgramId
number
name
required
string
description
string
pictureUrl
string
customAttributes
object
active
required
boolean
validFromDate
string <date-time>
validToDate
string <date-time>
maxPerCode
required
number
maxReferralsPerMember
required
number
Default: 9007199254740991

The maximum number of referrals per member

maxRedeemsPerReferredMemberPerCode
number
audienceId
number
tags
Array of strings
code
required
string
eventType
required
string
referrerPointsAccrual
number
referrerLedgerId
number
referrerLedgerAccountId
number
referredPointsAccrual
number
referredLedgerId
number
referredLedgerAccountId
number
referredCount
number
referrerCouponBookKey
string
referredCouponBookKey
string

Responses

Request samples

Content type
application/json
{
  • "loyaltyProgramId": 0,
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "customAttributes": { },
  • "active": true,
  • "validFromDate": "2019-08-24T14:15:22Z",
  • "validToDate": "2019-08-24T14:15:22Z",
  • "maxPerCode": 0,
  • "maxReferralsPerMember": 10,
  • "maxRedeemsPerReferredMemberPerCode": 0,
  • "audienceId": 0,
  • "tags": [
    ],
  • "code": "string",
  • "eventType": "string",
  • "referrerPointsAccrual": 0,
  • "referrerLedgerId": 0,
  • "referrerLedgerAccountId": 0,
  • "referredPointsAccrual": 0,
  • "referredLedgerId": 0,
  • "referredLedgerAccountId": 0,
  • "referredCount": 0,
  • "referrerCouponBookKey": "string",
  • "referredCouponBookKey": "string"
}

Response samples

Content type
application/json
{
  • "referralProgram": {
    }
}

ReferralsProgramController_getReferralMembersReport

Authorizations:
bearer
path Parameters
organizationId
required
number
referralProgramId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Campaign Actions

Get all the actions for an organization

Authorizations:
bearer
path Parameters
organizationId
required
number
campaignId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

status
string
Enum: "disabled" "running" "draft"

The status of the action

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new action

Authorizations:
bearer
path Parameters
organizationId
required
number
campaignId
required
number
Request Body schema: application/json
required
campaignVersionId
number
actionIndex
number
abortEvaluationIfFalse
boolean
abortEvaluationOnError
boolean
name
required
string
rules
object
effects
required
object
status
required
string
Enum: "disabled" "running" "draft"
priority
required
number
exclusiveGroup
string

Responses

Request samples

Content type
application/json
{
  • "campaignVersionId": 0,
  • "actionIndex": 0,
  • "abortEvaluationIfFalse": true,
  • "abortEvaluationOnError": true,
  • "name": "string",
  • "rules": { },
  • "effects": { },
  • "status": "disabled",
  • "priority": 0,
  • "exclusiveGroup": "string"
}

Response samples

Content type
application/json
{
  • "action": {
    }
}

Get an existing action details

Authorizations:
bearer
path Parameters
organizationId
required
number
campaignId
required
number
actionId
required
number

Responses

Response samples

Content type
application/json
{
  • "action": {
    }
}

Updates an existing action

Authorizations:
bearer
path Parameters
organizationId
required
number
campaignId
required
number
actionId
required
number
Request Body schema: application/json
required
campaignVersionId
number
actionIndex
number
abortEvaluationIfFalse
boolean
abortEvaluationOnError
boolean
name
required
string
rules
object
effects
required
object
status
required
string
Enum: "disabled" "running" "draft"
priority
required
number
exclusiveGroup
string

Responses

Request samples

Content type
application/json
{
  • "campaignVersionId": 0,
  • "actionIndex": 0,
  • "abortEvaluationIfFalse": true,
  • "abortEvaluationOnError": true,
  • "name": "string",
  • "rules": { },
  • "effects": { },
  • "status": "disabled",
  • "priority": 0,
  • "exclusiveGroup": "string"
}

Response samples

Content type
application/json
{
  • "action": {
    }
}

Campaigns

CampaignController_findAll

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

loyaltyProgramId
number >= 1

The loyalty program id

type
string
tags
string
codes
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

CampaignController_create

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
loyaltyProgramId
number
code
required
string
active
boolean
name
required
string
description
string
pictureUrl
string
type
string
tags
Array of strings
enabledTopics
Array of strings
audienceKeys
Array of strings
daysOfWeek
Array of strings
locationCodes
Array of strings
loyaltyTierKeys
Array of strings
eventType
string
pointsMonthlyLimitPerMember
number
allowPartialApplicationOnLimit
boolean
maxTransactionsPerMember
number
Array of objects (CampaignLimitRuleDto)

Unified campaign limit rules — one entry per (scope, type, period, ledgerAccountKey) combination. Combine multiple rules to express e.g. {transactions, everything, 3} + {transactions, monthly, 1} + {points, monthly, 50000}. An event must pass every rule of its type to qualify. A points rule may target a specific account via ledgerAccountKey; omit it to target the program's default account. Prefer this over the deprecated maxTransactionsPerMember and pointsMonthlyLimitPerMember fields.

minSpendValue
number
customAttributes
object
smartRewards
object
validFrom
string <date-time>
validTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "loyaltyProgramId": 0,
  • "code": "string",
  • "active": true,
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "type": "string",
  • "tags": [
    ],
  • "enabledTopics": [
    ],
  • "audienceKeys": [
    ],
  • "daysOfWeek": [
    ],
  • "locationCodes": [
    ],
  • "loyaltyTierKeys": [
    ],
  • "eventType": "string",
  • "pointsMonthlyLimitPerMember": 0,
  • "allowPartialApplicationOnLimit": true,
  • "maxTransactionsPerMember": 0,
  • "limitRules": [
    ],
  • "minSpendValue": 0,
  • "customAttributes": { },
  • "smartRewards": { },
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "campaign": {
    }
}

CampaignController_findOne

Authorizations:
bearer
path Parameters
organizationId
required
number
campaignId
required
number

Responses

Response samples

Content type
application/json
{
  • "campaign": {
    }
}

CampaignController_update

Authorizations:
bearer
path Parameters
organizationId
required
number
campaignId
required
number
Request Body schema: application/json
required
loyaltyProgramId
number
code
required
string
active
boolean
name
required
string
description
string
pictureUrl
string
type
string
tags
Array of strings
enabledTopics
Array of strings
audienceKeys
Array of strings
daysOfWeek
Array of strings
locationCodes
Array of strings
loyaltyTierKeys
Array of strings
eventType
string
pointsMonthlyLimitPerMember
number
allowPartialApplicationOnLimit
boolean
maxTransactionsPerMember
number
Array of objects (CampaignLimitRuleDto)

Unified campaign limit rules — one entry per (scope, type, period, ledgerAccountKey) combination. Combine multiple rules to express e.g. {transactions, everything, 3} + {transactions, monthly, 1} + {points, monthly, 50000}. An event must pass every rule of its type to qualify. A points rule may target a specific account via ledgerAccountKey; omit it to target the program's default account. Prefer this over the deprecated maxTransactionsPerMember and pointsMonthlyLimitPerMember fields.

minSpendValue
number
customAttributes
object
smartRewards
object
validFrom
string <date-time>
validTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "loyaltyProgramId": 0,
  • "code": "string",
  • "active": true,
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "type": "string",
  • "tags": [
    ],
  • "enabledTopics": [
    ],
  • "audienceKeys": [
    ],
  • "daysOfWeek": [
    ],
  • "locationCodes": [
    ],
  • "loyaltyTierKeys": [
    ],
  • "eventType": "string",
  • "pointsMonthlyLimitPerMember": 0,
  • "allowPartialApplicationOnLimit": true,
  • "maxTransactionsPerMember": 0,
  • "limitRules": [
    ],
  • "minSpendValue": 0,
  • "customAttributes": { },
  • "smartRewards": { },
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "campaign": {
    }
}

Search

Get all the members indexes

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

loyaltyTierId
number >= 1
loyaltyProgramId
number >= 1
query
string

Filter by full text search

sinceFrom
string <date-time>
sinceTo
string <date-time>
memberType
string
channelAcquisition
string
loyaltyTierKey
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Stats

Get stats for member creation

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
sinceFrom
string <date-time>
Example: sinceFrom=2024-01-01T00:00:00.000Z
sinceTo
string <date-time>
Example: sinceTo=2024-08-01T00:00:00.000Z

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get stats for benefits usages by date

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
sinceFrom
string <date-time>
Example: sinceFrom=2024-01-01T00:00:00.000Z
sinceTo
string <date-time>
Example: sinceTo=2024-08-01T00:00:00.000Z

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get stats for benefits performance

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
sinceFrom
string <date-time>
Example: sinceFrom=2024-01-01T00:00:00.000Z
sinceTo
string <date-time>
Example: sinceTo=2024-08-01T00:00:00.000Z
limit
number
Example: limit=10
orderByUsage
boolean
Example: orderByUsage=true

If true it will order by usage, if not present it will order by assign

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get stats for coupon book usages

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
sinceFrom
string <date-time>
Example: sinceFrom=2024-01-01T00:00:00.000Z
sinceTo
string <date-time>
Example: sinceTo=2024-08-01T00:00:00.000Z
tag
string
Example: tag=cash

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get top members for mission

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
sinceFrom
string <date-time>
Example: sinceFrom=2024-01-01T00:00:00.000Z
sinceTo
string <date-time>
Example: sinceTo=2024-08-01T00:00:00.000Z
limit
number
Example: limit=10
tag
string
Example: tag=stamp

Responses

Response samples

Content type
application/json
{}

Get stats for mission

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
sinceFrom
string <date-time>
Example: sinceFrom=2024-01-01T00:00:00.000Z
sinceTo
string <date-time>
Example: sinceTo=2024-08-01T00:00:00.000Z
tag
string
Example: tag=stamp

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get totals for mission

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
sinceFrom
string <date-time>
Example: sinceFrom=2024-01-01T00:00:00.000Z
sinceTo
string <date-time>
Example: sinceTo=2024-08-01T00:00:00.000Z
tag
string
Example: tag=stamp

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get stats for loyaltyProgram tiers

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyProgramId
required
number

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get stats for ledger accounts

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerAccountId
required
number
query Parameters
sinceFrom
string <date-time>
Example: sinceFrom=2024-01-01T00:00:00.000Z
sinceTo
string <date-time>
Example: sinceTo=2024-08-01T00:00:00.000Z

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get stats for events

Authorizations:
bearer
path Parameters
organizationId
required
number
eventType
required
string
query Parameters
sinceFrom
string <date-time>
Example: sinceFrom=2024-01-01T00:00:00.000Z
sinceTo
string <date-time>
Example: sinceTo=2024-08-01T00:00:00.000Z

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get stats for coupon book discount amounts

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
sinceFrom
string <date-time>
Example: sinceFrom=2024-01-01T00:00:00.000Z
sinceTo
string <date-time>
Example: sinceTo=2024-08-01T00:00:00.000Z
discountType
string
Example: discountType=fixed

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get total mission completions by members

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
limit
number
Example: limit=4

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get NPS Survey Stats

Authorizations:
bearer
path Parameters
surveyId
required
number

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Audiences

Get all the audiences for an organization

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

matcherType
string
Enum: "attribute-matcher" "list-matcher" "null-matcher"

Filter by matcher type

active
boolean

Filter audiences by active status. When true, also excludes audiences whose expiresAt is in the past.

search
string
Example: search=VIP customers

Search audiences by name or description

audienceKeys
string
Example: audienceKeys=aud_123,aud_456,aud_789

Filter audiences by specific audience keys (comma-separated)

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new audience

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
active
required
boolean
organizationId
required
number
name
required
string
description
string
matcherType
required
string
Enum: "attribute-matcher" "list-matcher" "null-matcher"
AttributeMatcherDto (object)

Matcher configuration. Required when matcherType is attribute-matcher.

segmentKey
string
refreshedAt
string <date-time>
expiresAt
string <date-time>
memberCount
number

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "matcherType": "attribute-matcher",
  • "matcher": {
    },
  • "segmentKey": "string",
  • "refreshedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "memberCount": 0
}

Response samples

Content type
application/json
{
  • "active": true,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "matcherType": "attribute-matcher",
  • "matcher": {
    },
  • "segmentKey": "string",
  • "refreshedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "memberCount": 0
}

Get an existing audience details

Authorizations:
bearer
path Parameters
organizationId
required
number
audienceId
required
number

Responses

Response samples

Content type
application/json
{
  • "audience": {
    }
}

Updates an existing audience

Authorizations:
bearer
path Parameters
organizationId
required
number
audienceId
required
number
Request Body schema: application/json
required
active
boolean
organizationId
number
name
string
description
string
matcherType
string
Enum: "attribute-matcher" "list-matcher" "null-matcher"
AttributeMatcherDto (object)

Matcher configuration. Required when matcherType is attribute-matcher.

segmentKey
string
refreshedAt
string <date-time>
expiresAt
string <date-time>
memberCount
number

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "matcherType": "attribute-matcher",
  • "matcher": {
    },
  • "segmentKey": "string",
  • "refreshedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "memberCount": 0
}

Response samples

Content type
application/json
{
  • "audience": {
    }
}

Gets matching audiences for a member

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
audienceIds
required
Array of numbers
required
object (MemberOrganizationAssociationDto)

Responses

Request samples

Content type
application/json
{
  • "audienceIds": [
    ],
  • "member": {
    }
}

Response samples

Content type
application/json
{
  • "audienceIds": [
    ]
}

Ledgers

Gets a single Ledger

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number

Responses

Response samples

Content type
application/json
{
  • "ledger": {
    }
}

Updates a single Ledger

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
Request Body schema: application/json
required
name
required
string
description
string
defaultAccountId
number

Responses

Request samples

Content type
application/json
{
  • "name": "Main Loyalty Program Ledger",
  • "description": "This is the main Loyalty Program Ledger",
  • "defaultAccountId": 0
}

Response samples

Content type
application/json
{
  • "ledger": {
    }
}

Gets all Ledgers

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0

The page number for pagination

limit
number [ 1 .. 25 ]
Example: limit=10

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

ledgerKey
string

Ledger Key

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a single Ledger

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "Main Loyalty Program Ledger",
  • "description": "This is the main Loyalty Program Ledger"
}

Response samples

Content type
application/json
{
  • "ledger": {
    }
}

Ledger Accounts and Wallets

Gets a single Ledger Account

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
ledgerAccountId
required
number

Responses

Response samples

Content type
application/json
{
  • "ledgerAccount": {
    }
}

Updates a single Ledger Account

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
ledgerAccountId
required
number
Request Body schema: application/json
required
alias
string

Account alias for easier lookup

name
string
active
boolean
isCurrency
boolean

Optional Is a currency? for account

decimals
number

Optional decimals

formatString
string

Optional Format string for points

isRevolving
boolean
pointTrackingEnabled
boolean
syncAlgorand
boolean

Enable algorand blockchain syncing

expiresInMonths
number

Points expiration in months

Array of objects (ExpirationPolicyDto)

Expiration policies for the account

overdraftLimit
number

Outstanding-debt cap for overdraft on this account. NULL or <= 0 disables overdraft. > 0 enables it (only on revolving accounts; pending transfers are not supported when overdraft is enabled).

isDefaultAccount
boolean

Is default account for ledger

Responses

Request samples

Content type
application/json
{
  • "alias": "string",
  • "name": "Main Ledger Account",
  • "active": true,
  • "isCurrency": true,
  • "decimals": 0,
  • "formatString": "string",
  • "isRevolving": true,
  • "pointTrackingEnabled": true,
  • "syncAlgorand": true,
  • "expiresInMonths": 0,
  • "expirationPolicies": [
    ],
  • "overdraftLimit": 0,
  • "isDefaultAccount": true
}

Response samples

Content type
application/json
{
  • "ledgerAccount": {
    }
}

Gets a single Ledger Account Wallet Balance

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
ledgerAccountId
required
number
walletId
required
number

Responses

Response samples

Content type
application/json
{
  • "wallet": {
    }
}

Gets all Ledger's Accounts

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
query Parameters
page
number >= 0

The page number for pagination

limit
number [ 1 .. 25 ]
Example: limit=10

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

name
string
ledgerAccountKey
string

Ledger Account Key

alias
string

Account Alias

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a single Ledger Account

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
Request Body schema: application/json
required
alias
string

Account alias for easier lookup

name
required
string
active
required
boolean
isCurrency
boolean

Optional Is a currency? for account

decimals
number

Optional decimals

formatString
string

Optional Format string for points

maxSupply
number

Max points supply available (max allowed 18446744073709)

isRevolving
required
boolean
pointTrackingEnabled
boolean
syncAlgorand
required
boolean

Enable algorand blockchain syncing

expiresInMonths
number

Points expiration in months

Array of objects (ExpirationPolicyDto)

Expiration policies for the account

overdraftLimit
number

Outstanding-debt cap for overdraft on this account. NULL or <= 0 disables overdraft. > 0 enables it (only on revolving accounts; pending transfers are not supported when overdraft is enabled).

isDefaultAccount
boolean

Is default account for ledger

Responses

Request samples

Content type
application/json
{
  • "alias": "string",
  • "name": "Main Ledger Account",
  • "active": true,
  • "isCurrency": true,
  • "decimals": 0,
  • "formatString": "string",
  • "maxSupply": 0,
  • "isRevolving": true,
  • "pointTrackingEnabled": true,
  • "syncAlgorand": true,
  • "expiresInMonths": 0,
  • "expirationPolicies": [
    ],
  • "overdraftLimit": 0,
  • "isDefaultAccount": true
}

Response samples

Content type
application/json
{
  • "ledgerAccount": {
    }
}

Updates a single Ledger Account's Supply

Use an empty maxSupply or body {} to increase to an infinite supply.

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
ledgerAccountId
required
number
Request Body schema: application/json
required
externalEventDate
string <date-time>

Optional Reference Event Date

systemUniqueKey
string

System Unique Key for tracking

externalId
string

Event Id for tracking

description
string
tags
Array of arrays
maxSupply
number

Max points supply available (max allowed 18446744073709)

Responses

Request samples

Content type
application/json
{
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "systemUniqueKey": "string",
  • "externalId": "string",
  • "description": "string",
  • "tags": [
    ],
  • "maxSupply": 0
}

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Ledger Transactions

List Ledger's Account Transactions

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
ledgerAccountId
required
number
query Parameters
page
number >= 0

The page number for pagination

limit
number [ 1 .. 25 ]
Example: limit=10

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

fromExternalEventDate
string <date-time>

Optional Reference From Event Date

toExternalEventDate
string <date-time>

Optional Reference To Event Date

fromLedgerTransactionId
number

Optional Starting ledgerTransactionId

toLedgerTransactionId
number

Optional Ending ledgerTransactionId

systemUniqueKey
string

Optional System Unique Key for tracking

walletId
number

Optional Wallet Id

tags
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Transfer points from/to Account Wallets

Amount must be a large integer (bigint or number, max allowed 18446744073709)

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
ledgerAccountId
required
number
Request Body schema: application/json
required
externalEventDate
string <date-time>

Optional Reference Event Date

systemUniqueKey
string

System Unique Key for tracking

externalId
string

Event Id for tracking

description
string
tags
Array of arrays
amount
required
number

Amount to mint or burn to account (max allowed 18446744073709)

fromWalletId
required
number
toWalletId
required
number
fiatValue
number

Fiat value associated with the transaction. Only accepted on burn transactions — rejected with 409 on mint/transfer/revert.

fiatGrossAmount
number

Fiat gross amount associated with the transaction. Only accepted on burn transactions — rejected with 409 on mint/transfer/revert.

fiatCurrency
string

Fiat currency code (e.g. USD, EUR). Only accepted on burn transactions — rejected with 409 on mint/transfer/revert.

captureMethod
string
Default: "auto"
Enum: "manual" "auto"

Capture method for the transaction

allowOverdraft
boolean
Default: false

Opt-in to let a burn (or revert-of-mint) with shortfall drive the user wallet into overdraft debt instead of failing Insufficient balance. Requires the account to be revolving with overdraftLimit > 0. Ignored otherwise.

Responses

Request samples

Content type
application/json
{
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "systemUniqueKey": "string",
  • "externalId": "string",
  • "description": "string",
  • "tags": [
    ],
  • "amount": 0,
  • "fromWalletId": 0,
  • "toWalletId": 0,
  • "fiatValue": 0,
  • "fiatGrossAmount": 0,
  • "fiatCurrency": "string",
  • "captureMethod": "auto",
  • "allowOverdraft": false
}

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Transfer multiple points from different Accounts from/to Wallets in a single all or nothing transaction

Amount must be a large integer (bigint or number, max allowed 18446744073709)

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
Request Body schema: application/json
required
required
Array of objects (CreateLedgerTransactionSetItemDto)
Array
externalEventDate
string <date-time>

Optional Reference Event Date

systemUniqueKey
string

System Unique Key for tracking

externalId
string

Event Id for tracking

description
string
tags
Array of arrays
amount
required
number

Amount to mint or burn to account (max allowed 18446744073709)

fromWalletId
required
number
toWalletId
required
number
fiatValue
number

Fiat value associated with the transaction. Only accepted on burn transactions — rejected with 409 on mint/transfer/revert.

fiatGrossAmount
number

Fiat gross amount associated with the transaction. Only accepted on burn transactions — rejected with 409 on mint/transfer/revert.

fiatCurrency
string

Fiat currency code (e.g. USD, EUR). Only accepted on burn transactions — rejected with 409 on mint/transfer/revert.

captureMethod
string
Default: "auto"
Enum: "manual" "auto"

Capture method for the transaction

allowOverdraft
boolean
Default: false

Opt-in to let a burn (or revert-of-mint) with shortfall drive the user wallet into overdraft debt instead of failing Insufficient balance. Requires the account to be revolving with overdraftLimit > 0. Ignored otherwise.

ledgerAccountId
required
number

Responses

Request samples

Content type
application/json
{
  • "create": [
    ]
}

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Reverts an existing Transaction

Amount must be a large integer (bigint or number, max allowed 18446744073709)

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
ledgerAccountId
required
number
Request Body schema: application/json
required
externalEventDate
string <date-time>

Optional Reference Event Date

systemUniqueKey
string

System Unique Key for tracking

externalId
string

Event Id for tracking

description
string
tags
Array of arrays
partialFiatValue
number

Explicit fiat amount to subtract from total_fiat_value on a revert-of-burn. When provided, overrides automatic proration (fiatValue × revertAmount / originalAmount). Must be ≥ 0. Only valid on revert transactions.

Responses

Request samples

Content type
application/json
{
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "systemUniqueKey": "string",
  • "externalId": "string",
  • "description": "string",
  • "tags": [
    ],
  • "partialFiatValue": 0
}

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Burn points from Wallet

Amount must be a large integer (bigint or number, max allowed 18446744073709)

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
ledgerAccountId
required
number
walletId
required
number
Request Body schema: application/json
required
amount
required
number

Amount to mint or burn to account (max allowed 18446744073709)

systemUniqueKey
string

System Unique Key for tracking

externalEventDate
string <date-time>

External event date

externalId
string

External event id

description
string

Description of the burn transaction

tags
Array of strings

Tags

captureMethod
string
Default: "auto"
Enum: "manual" "auto"

Capture method for the transaction

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "systemUniqueKey": "string",
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "description": "string",
  • "tags": [
    ],
  • "captureMethod": "auto"
}

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Mint points from Wallet

Amount must be a large integer (bigint or number, max allowed 18446744073709)

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
ledgerAccountId
required
number
walletId
required
number
Request Body schema: application/json
required
amount
required
number

Amount to mint or burn to account (max allowed 18446744073709)

systemUniqueKey
string

System Unique Key for tracking

externalEventDate
string <date-time>

External event date

externalId
string

External event id

description
string

Description of the burn transaction

tags
Array of strings

Tags

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "systemUniqueKey": "string",
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "description": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Capture pending transactions

Capture pending transactions for the given ledger account. Transactions must be in pending state.

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
ledgerAccountId
required
number
Request Body schema: application/json
required
required
Array of objects (CaptureTransactionDto)

Ledger transactions to capture

Array
ledgerTransactionId
required
string

Ledger Transaction Id

captureAmount
number

Optional amount to capture from the transaction. Must be less than or equal to the transaction amount.

Responses

Request samples

Content type
application/json
{
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "ok": true
}

Ledger Batch Transaction Processing

Process a batch of transactions for a given organization Id

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
required
Array of objects (LedgerTransactionBatchItemRequestDto)
Array
externalEventDate
string <date-time>

Optional Reference Event Date

systemUniqueKey
string

System Unique Key for tracking

externalId
string

Event Id for tracking

description
string
tags
Array of arrays
amount
required
number

Amount to mint or burn to account (max allowed 18446744073709)

fromWalletId
required
number
toWalletId
required
number
fiatValue
number

Fiat value associated with the transaction. Only accepted on burn transactions — rejected with 409 on mint/transfer/revert.

fiatGrossAmount
number

Fiat gross amount associated with the transaction. Only accepted on burn transactions — rejected with 409 on mint/transfer/revert.

fiatCurrency
string

Fiat currency code (e.g. USD, EUR). Only accepted on burn transactions — rejected with 409 on mint/transfer/revert.

captureMethod
string
Default: "auto"
Enum: "manual" "auto"

Capture method for the transaction

allowOverdraft
boolean
Default: false

Opt-in to let a burn (or revert-of-mint) with shortfall drive the user wallet into overdraft debt instead of failing Insufficient balance. Requires the account to be revolving with overdraftLimit > 0. Ignored otherwise.

organizationId
number

Optional Organization Id (not used for now)

ledgerId
required
number
ledgerAccountId
required
number
atomicSetId
number

Optional Reference Atomic Set Id, for atomic transaction processing

expirationDate
string <date-time>

Custom expiration date for the minted points. Only valid on mint items (fromWalletId=0). Must be in the future. Requires pointTrackingEnabled on the target account.

revertedLedgerTransactionId
string

Original transaction id to revert in-batch. When set, the batch item is processed as a revert of that transaction (from/to wallets and amount are derived from the original).

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "processed": [
    ],
  • "failed": [
    ]
}

Revert a batch of transactions for a given organization Id

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
transactionIds
required
Array of strings

List of transaction IDs to revert

burnAvailableBalance
boolean
Default: false

When true, if a mint revert would fail due to insufficient balance, burns only the available balance instead of failing

allowOverdraft
boolean
Default: false

When true, a mint revert whose funds were already (partly) spent drives the user wallet into overdraft debt instead of clamping. Requires the account to be revolving with overdraftLimit > 0 (else the revert fails Insufficient balance). Takes precedence over burnAvailableBalance.

Array of objects (BatchRevertFiatItemDto)

Per-transaction explicit fiat override for revert-of-burn. Each entry's ledgerTransactionId must also appear in transactionIds and reference a burn; the supplied partialFiatValue is subtracted from total_fiat_value instead of the auto-prorated value. Entries referencing a non-burn transaction fail that item.

Responses

Request samples

Content type
application/json
{
  • "transactionIds": [
    ],
  • "burnAvailableBalance": false,
  • "allowOverdraft": false,
  • "partialFiatValues": [
    ]
}

Response samples

Content type
application/json
{
  • "processed": [
    ],
  • "failed": [
    ]
}

Ledger Wallets

Gets all wallet balances

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
walletId
required
number

Responses

Response samples

Content type
application/json
{
  • "wallets": [
    ]
}

Gets the nearest pending expiration total amount grouped by day for a wallet and ledger account

Authorizations:
bearer
path Parameters
ledgerId
required
number
walletId
required
number

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Mints points to a wallet using default account for organization

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
walletId
required
number
Request Body schema: application/json
required
amount
required
number

Amount to mint or burn to account (max allowed 18446744073709)

systemUniqueKey
string

System Unique Key for tracking

externalEventDate
string <date-time>

External event date

externalId
string

External event id

description
string

Description of the transaction

tags
Array of strings

Tags

expirationDate
string <date-time>

Custom expiration date for the minted points. When set, overrides the account's default expiration policy for this mint only. Must be in the future.

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "systemUniqueKey": "string",
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "description": "string",
  • "tags": [
    ],
  • "expirationDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Burns points from a wallet using default account for organization

Authorizations:
bearer
path Parameters
organizationId
required
number
ledgerId
required
number
walletId
required
number
Request Body schema: application/json
required
amount
required
number

Amount to mint or burn to account (max allowed 18446744073709)

systemUniqueKey
string

System Unique Key for tracking

externalEventDate
string <date-time>

External event date

externalId
string

External event id

description
string

Description of the transaction

tags
Array of strings

Tags

captureMethod
string
Default: "auto"
Enum: "manual" "auto"

Capture method for the transaction

allowOverdraft
boolean
Default: false

Opt-in to let this burn (from the org's default account) with shortfall drive the user wallet into overdraft debt instead of failing Insufficient balance. Requires the default account to be revolving with overdraftLimit > 0. Ignored otherwise.

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "systemUniqueKey": "string",
  • "externalEventDate": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "description": "string",
  • "tags": [
    ],
  • "captureMethod": "auto",
  • "allowOverdraft": false
}

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Organizations

Gets an existing Organization details

Authorizations:
bearer
path Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
{
  • "organization": {
    }
}

Updates an existing Organization

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
name
required
string
description
required
string
pictureUrl
required
string
defaultLoyaltyProgramId
required
number
defaultLocale
required
string
locales
Array of strings
customAttributes
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "defaultLoyaltyProgramId": 123456,
  • "defaultLocale": "string",
  • "locales": [
    ],
  • "customAttributes": {
    }
}

Response samples

Content type
application/json
{
  • "organization": {
    }
}

Loyalty Program Tiers

List of Loyalty Tiers

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyProgramId
required
number
query Parameters
page
number >= 0
Deprecated
Example: page=0

[Deprecated] The page number for pagination. Paging is being phased out for tier lists.

limit
number [ 1 .. 25 ]
Deprecated
Example: limit=10

[Deprecated] The limit of items to return per page. Paging is being phased out for tier lists.

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

loyaltyTierKey
string

Loyalty Tier Key

onlyActive
boolean

Only active loyalty tiers

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new Loyalty Tier

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyProgramId
required
number
Request Body schema: application/json
required
name
required
string

Descriptive name for this Level.

active
required
boolean
minRequiredPoints
required
number

Minimun balance in Point Accrual Account to move to this Tier Level

tierOrder
required
number

Order between all the program tiers.

customAttributes
object
pictureUrl
string

Descriptive image url for this tier.

isDefault
boolean

Boolean to set tier as default

Responses

Request samples

Content type
application/json
{
  • "name": "Silver",
  • "active": true,
  • "minRequiredPoints": 1000,
  • "tierOrder": 1,
  • "customAttributes": {
    },
  • "pictureUrl": "https://example.com/image.png",
  • "isDefault": true
}

Response samples

Content type
application/json
{
  • "tier": {
    }
}

Gets a Single Loyalty Tier details

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyProgramId
required
number
loyaltyTierId
required
number

Responses

Response samples

Content type
application/json
{
  • "tier": {
    }
}

Updates an existing Loyalty Tier

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyProgramId
required
number
loyaltyTierId
required
number
Request Body schema: application/json
required
name
required
string

Descriptive name for this Level.

active
required
boolean
minRequiredPoints
required
number

Minimun balance in Point Accrual Account to move to this Tier Level

tierOrder
required
number

Order between all the program tiers.

customAttributes
object
pictureUrl
string

Descriptive image url for this tier.

isDefault
boolean

Boolean to set tier as default

Responses

Request samples

Content type
application/json
{
  • "name": "Silver",
  • "active": true,
  • "minRequiredPoints": 1000,
  • "tierOrder": 1,
  • "customAttributes": {
    },
  • "pictureUrl": "https://example.com/image.png",
  • "isDefault": true
}

Response samples

Content type
application/json
{
  • "tier": {
    }
}

Loyalty Programs

LoyaltyProgramController_findOne

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyProgramId
required
number

Responses

Response samples

Content type
application/json
{
  • "loyaltyProgram": {
    }
}

LoyaltyProgramController_update

Authorizations:
bearer
path Parameters
organizationId
required
number
loyaltyProgramId
required
number
Request Body schema: application/json
required
active
required
boolean
name
required
string
ledgerId
required
number
tierPointsLedgerAccountId
number
mainLedgerAccountId
number
description
required
string

Loyalty Program short Description

setAsDefault
required
boolean

Sets as organization's default Loyalty Program

mainPortalId
number

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "name": "My Super Loyalty Program",
  • "ledgerId": "123456",
  • "tierPointsLedgerAccountId": "123456",
  • "mainLedgerAccountId": "123456",
  • "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt...",
  • "setAsDefault": true,
  • "mainPortalId": "123456"
}

Response samples

Content type
application/json
{
  • "loyaltyProgram": {
    }
}

LoyaltyProgramController_findAll

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Deprecated
Example: page=0

[Deprecated] The page number for pagination. Paging is being phased out for program lists.

limit
number [ 1 .. 25 ]
Deprecated
Example: limit=10

[Deprecated] The limit of items to return per page. Paging is being phased out for program lists.

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

default
boolean
Default: true
loyaltyProgramKey
string

Loyalty Program Key

Responses

Response samples

Content type
application/json
{
  • "loyaltyPrograms": [
    ]
}

LoyaltyProgramController_create

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
active
required
boolean
name
required
string
ledgerId
required
number
tierPointsLedgerAccountId
number
mainLedgerAccountId
number
description
required
string

Loyalty Program short Description

setAsDefault
required
boolean

Sets as organization's default Loyalty Program

mainPortalId
number
defaultTierId
number

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "name": "My Super Loyalty Program",
  • "ledgerId": "123456",
  • "tierPointsLedgerAccountId": "123456",
  • "mainLedgerAccountId": "123456",
  • "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt...",
  • "setAsDefault": true,
  • "mainPortalId": "123456",
  • "defaultTierId": "123456"
}

Response samples

Content type
application/json
{
  • "loyaltyProgram": {
    }
}

Organization Users

OrganizationUserController_findAll

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

email
string
userName
string

Filter by user name

organizationId
number

Filter by organization id

active
boolean
authClientId
string

Filter by auth client id

includeAPIUsers
boolean
includeCognitoUsers
boolean
search
string

Filter by full text search

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

OrganizationUserController_create

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
active
required
boolean

Active flag. On the admin endpoint this is the GLOBAL user flag (mirrors Cognito enabled, blocks login in every org). On the org-scoped endpoint it is applied to the caller's membership only (per-org), unless overridden by an organizations[] entry's own active.

name
required
string
nickname
required
string
profilePictureUrl
required
string
isSystemAdmin
required
boolean
pendingProvisioning
required
boolean
permissionGroupKeys
Array of arrays

Permission groups the new user belongs to, stored alongside (not overriding) the inline isAdmin/roles extras above.

passwordIsTemporary
boolean

Create password as temporary

password
string

User temporary password

sendInvite
boolean

Send invite to user

isAdmin
required
boolean
roles
required
Array of strings
Items Enum: "ledgers:write" "ledgers:read" "orders:write" "orders:read" "campaigns:write" "campaigns:read" "badges:write" "badges:read" "benefits:write" "benefits:read" "tiers:write" "tiers:read" "members:write" "members:read" "coupons:write" "coupons:read" "partnerships:write" "partnerships:read" "users:write" "users:read"

Inline permission-role extras stored on the new user, merged with permissionGroupKeys at read/token time.

emailIsVerified
boolean

Set email as verified

userName
required
string

Unique User Name

email
required
string

User email address

authClientId
required
string

Auth Client Id of the App that created the user

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "name": "John Connor",
  • "nickname": "user-123456",
  • "profilePictureUrl": "https://some-uri.com/my-picture-profile.png",
  • "isSystemAdmin": true,
  • "pendingProvisioning": true,
  • "permissionGroupKeys": [
    ],
  • "passwordIsTemporary": false,
  • "password": "my-secret-password",
  • "sendInvite": false,
  • "isAdmin": true,
  • "roles": [
    ],
  • "emailIsVerified": true,
  • "userName": "johnconnor",
  • "email": "john@connor.com",
  • "authClientId": "CLIENT-123456"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "password": "my-secret-password"
}

OrganizationUserController_findOne

Authorizations:
bearer
path Parameters
organizationId
required
number
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

OrganizationUserController_update

Authorizations:
bearer
path Parameters
organizationId
required
number
userId
required
string
Request Body schema: application/json
required
name
required
string
nickname
required
string
profilePictureUrl
required
string
isSystemAdmin
required
boolean
pendingProvisioning
required
boolean
required
Array of objects (OrganizationUserDto)

Related organizations, reconciled add/update-only: each entry adds the membership if absent or replaces its stored permissions in place, and a membership omitted from the list is preserved. To remove a user from an organization use DELETE /org/:organizationId/users/:userId.

permissionGroupKeys
Array of arrays

Permission groups for this user's membership in the current organization. Stored alongside the inline organizations[] extras and merged with them at read/token time (additive — groups do NOT override the inline roles).

active
boolean
Default: true

Per-org active flag for the caller's organization. Omit to leave the membership's current active state unchanged. An organizations[] entry's own active takes precedence.

email
string

Ignored on the org-scoped endpoint (immutable identity). Accepted so a full-object round-trip from a frontend that echoes the GET response passes validation; never persisted here.

userName
string

Ignored on the org-scoped endpoint (immutable identity). See email.

authClientId
string

Ignored on the org-scoped endpoint (immutable identity). See email.

Responses

Request samples

Content type
application/json
{
  • "name": "John Connor",
  • "nickname": "user-123456",
  • "profilePictureUrl": "https://some-uri.com/my-picture-profile.png",
  • "isSystemAdmin": true,
  • "pendingProvisioning": true,
  • "organizations": [
    ],
  • "permissionGroupKeys": [
    ],
  • "active": true,
  • "email": "string",
  • "userName": "string",
  • "authClientId": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    }
}

OrganizationUserController_delete

Authorizations:
bearer
path Parameters
organizationId
required
number
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

OrganizationUserController_bulkCreate

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
emails
required
Array of arrays

Emails to add, each receiving the same permissions

isAdmin
boolean

Grants org-wide admin to every user. Stored as an inline extra and merged (OR-ed) with any permission group's admin flag at read/token time.

roles
Array of arrays

Inline permission-role extras ("resource:action") stored on every user, merged with any permissionGroupKeys at read/token time.

permissionGroupKeys
Array of arrays

Permission groups applied to every user, stored alongside (not overriding) the inline isAdmin/roles extras above.

sendInvite
boolean

Send each new user a Cognito invitation email (default true)

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "isAdmin": false,
  • "roles": [
    ],
  • "permissionGroupKeys": [
    ],
  • "sendInvite": true
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "summary": {
    }
}

OrganizationUserController_bulkEdit

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
emails
required
Array of arrays

Emails of existing members whose permissions to reassign

isAdmin
boolean

Inline org-admin extra applied to every listed member (merged with any group's admin flag at read/token time).

roles
Array of arrays

Inline permission-role extras ("resource:action") applied to every listed member.

permissionGroupKeys
Array of arrays

Permission groups applied to every listed member, stored alongside the inline extras.

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "isAdmin": false,
  • "roles": [
    ],
  • "permissionGroupKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "summary": {
    }
}

OrganizationUserController_bulkDelete

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
emails
required
Array of arrays

Emails to remove from the organization

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "summary": {
    }
}

OrganizationUserController_updatePermissions

Authorizations:
bearer
path Parameters
organizationId
required
number
userId
required
string
Request Body schema: application/json
required
isAdmin
boolean

Inline org-wide admin extra. Required unless a permission group is provided.

roles
Array of strings
Items Enum: "ledgers:write" "ledgers:read" "orders:write" "orders:read" "campaigns:write" "campaigns:read" "badges:write" "badges:read" "benefits:write" "benefits:read" "tiers:write" "tiers:read" "members:write" "members:read" "coupons:write" "coupons:read" "partnerships:write" "partnerships:read" "users:write" "users:read"

Inline permission-role extras. Required unless a permission group is provided.

permissionGroupKeys
Array of arrays

Permission groups the user belongs to. Stored alongside the inline isAdmin/roles extras and merged with them at read/token time (highest action per resource wins).

Responses

Request samples

Content type
application/json
{
  • "isAdmin": true,
  • "roles": [
    ],
  • "permissionGroupKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "user": {
    }
}

OrganizationUserController_adminSetPassword

Authorizations:
bearer
path Parameters
organizationId
required
number
userId
required
string
Request Body schema: application/json
required
permanent
boolean

Indicates if the password is permanent

password
required
string

The new password

Responses

Request samples

Content type
application/json
{
  • "permanent": true,
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    }
}

Portals

Get all portals

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Deprecated
Example: page=0

[Deprecated] The page number for pagination. Paging is being phased out for portal lists.

limit
number [ 1 .. 25 ]
Deprecated
Example: limit=10

[Deprecated] The limit of items to return per page. Paging is being phased out for portal lists.

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

publicId
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "limit": 0,
  • "results": [
    ]
}

Create portal

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
name
required
string
customAttributes
object
links
object
theme
object
forms
object
metadata
object
active
required
boolean
loyaltyProgramId
number
authRedirectUrl
string
authValidScopes
Array of strings
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "customAttributes": { },
  • "links": { },
  • "theme": { },
  • "forms": { },
  • "metadata": { },
  • "active": true,
  • "loyaltyProgramId": 0,
  • "authRedirectUrl": "string",
  • "authValidScopes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "portal": {
    }
}

Get portal by id

Authorizations:
bearer
path Parameters
organizationId
required
number
portalId
required
number

Responses

Response samples

Content type
application/json
{
  • "portal": {
    }
}

Update portal

Authorizations:
bearer
path Parameters
organizationId
required
number
portalId
required
number
Request Body schema: application/json
required
name
required
string
publicId
required
string
customAttributes
object
links
object
theme
object
forms
object
metadata
object
active
required
boolean
loyaltyProgramId
number
authRedirectUrl
string
authValidScopes
Array of strings
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "publicId": "string",
  • "customAttributes": { },
  • "links": { },
  • "theme": { },
  • "forms": { },
  • "metadata": { },
  • "active": true,
  • "loyaltyProgramId": 0,
  • "authRedirectUrl": "string",
  • "authValidScopes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "portal": {
    }
}

Get portal by public id

Authorizations:
bearer
path Parameters
publicId
required
string

Responses

Response samples

Content type
application/json
{
  • "portal": {
    }
}

Order Locations

List of Order Locations

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

orderLocationCodes
string

Filter by location codes (comma-separated)

orderLocationLabel
string

Filter by order location label (partial match, case insensitive)

tags
string

Filter by tags (comma-separated, returns locations that contain any of the specified tags)

type
string
Enum: "location" "group"

Filter by location type

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "totalCount": 25,
  • "limit": 10,
  • "page": 1
}

Create a new Order Location (location or group)

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
orderLocationCode
required
string

Order location code identifier

orderLocationLabel
required
string

Order location display label

type
string
Enum: "location" "group"

Type of order location. Defaults to 'location'.

tags
Array of strings

Order location tags

filterTags
Array of strings

Tags filter for group membership (only for type 'group')

filterLabelPattern
string

Label contains filter for matching locations (only for type 'group')

filterExcludedCodes
Array of strings

Location codes to explicitly exclude from the group (only for type 'group')

Responses

Request samples

Content type
application/json
{
  • "orderLocationCode": "argentina",
  • "orderLocationLabel": "Argentina",
  • "type": "location",
  • "tags": [
    ],
  • "filterTags": [
    ],
  • "filterLabelPattern": "ramos",
  • "filterExcludedCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "orderLocation": {
    }
}

Get Order Location details

Authorizations:
bearer
path Parameters
organizationId
required
number
orderLocationCode
required
string

Responses

Response samples

Content type
application/json
{
  • "orderLocation": {
    }
}

Update an Order Location (validates by stored type)

Authorizations:
bearer
path Parameters
organizationId
required
number
orderLocationCode
required
string
Request Body schema: application/json
required
type
string
Enum: "location" "group"

Type cannot be changed after creation. Sending a different type will return 400.

orderLocationLabel
string

Order location display label

tags
Array of strings

Order location tags

filterTags
Array of strings

Tags filter for group membership (only for type 'group')

filterLabelPattern
string

Label contains filter for matching locations (only for type 'group')

filterExcludedCodes
Array of strings

Location codes to explicitly exclude from the group (only for type 'group')

Responses

Request samples

Content type
application/json
{
  • "type": "location",
  • "orderLocationLabel": "Argentina",
  • "tags": [
    ],
  • "filterTags": [
    ],
  • "filterLabelPattern": "ramos",
  • "filterExcludedCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "orderLocation": {
    }
}

Delete an Order Location

Authorizations:
bearer
path Parameters
organizationId
required
number
orderLocationCode
required
string

Responses

Resolve location codes to their full group chains

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
codes
required
Array of strings

List of order location codes to resolve. Each code must be unique.

Responses

Request samples

Content type
application/json
{
  • "codes": [
    ]
}

Response samples

Content type
application/json
{
  • "resolvedCodes": [
    ]
}

Product Categories

ProductCategoryController_findAll

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

productCategoryCodes
Array of strings
Example: productCategoryCodes=electronics&productCategoryCodes=clothing&productCategoryCodes=food

Filter by product category codes

search
string

Filter by code, label or tags

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "totalCount": 25,
  • "limit": 10,
  • "page": 1
}

ProductCategoryController_create

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
productCategoryCode
required
string

Unique product category code

productCategoryLabel
required
string

Human-readable product category label

tags
Array of strings

Product category tags

Responses

Request samples

Content type
application/json
{
  • "productCategoryCode": "electronics",
  • "productCategoryLabel": "Electronics",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "productCategory": {
    }
}

ProductCategoryController_findOne

Authorizations:
bearer
path Parameters
organizationId
required
number
productCategoryCode
required
string

Responses

Response samples

Content type
application/json
{
  • "productCategory": {
    }
}

ProductCategoryController_update

Authorizations:
bearer
path Parameters
organizationId
required
number
productCategoryCode
required
string
Request Body schema: application/json
required
productCategoryCode
string

Unique product category code

productCategoryLabel
string

Human-readable product category label

tags
Array of strings

Product category tags

Responses

Request samples

Content type
application/json
{
  • "productCategoryCode": "electronics",
  • "productCategoryLabel": "Electronics",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "productCategory": {
    }
}

Permission Groups

PermissionGroupController_findAll

Authorizations:
bearer
path Parameters
organizationId
required
number

Responses

Response samples

Content type
application/json
{
  • "permissionGroups": [
    ]
}

PermissionGroupController_create

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
name
required
string

Display name of the group

description
string

Optional human-readable description of what the group grants

isAdmin
required
boolean

Grants org-wide admin (all permissions) when true; roles are ignored

roles
required
Array of arrays

Permission roles of the form "resource:action"

Responses

Request samples

Content type
application/json
{
  • "name": "Contact Center",
  • "description": "Read-only access to members and coupon books",
  • "isAdmin": false,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "permissionGroup": {
    }
}

PermissionGroupController_findOne

Authorizations:
bearer
path Parameters
organizationId
required
number
permissionGroupKey
required
string

Responses

Response samples

Content type
application/json
{
  • "permissionGroup": {
    }
}

PermissionGroupController_update

Authorizations:
bearer
path Parameters
organizationId
required
number
permissionGroupKey
required
string
Request Body schema: application/json
required
name
string
description
string
isAdmin
boolean
roles
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "name": "Contact Center",
  • "description": "Read-only access to members and coupon books",
  • "isAdmin": false,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "permissionGroup": {
    }
}

PermissionGroupController_delete

Authorizations:
bearer
path Parameters
organizationId
required
number
permissionGroupKey
required
string

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

OrganizationContent Schemas

Create a new content schema

Authorizations:
bearer
path Parameters
organizationId
required
number
Request Body schema: application/json
required
name
required
string
description
string
pictureUrl
string
type
required
number
active
required
boolean
schema
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "type": 0,
  • "active": true,
  • "schema": "string"
}

Response samples

Content type
application/json
{
  • "contentSchemaId": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "type": 0,
  • "active": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "contentSchemaVersionId": 0,
  • "schema": "string"
}

Retrieve all content schemas

Authorizations:
bearer
path Parameters
organizationId
required
number
query Parameters
page
number >= 0
Example: page=0

The page number for pagination

limit
number [ 1 .. 100 ]
Example: limit=100

The limit of items to return per page

order
string

Order of results as a comma-separated 'column' with an optional direction. Samples: ?order=col1, ?order=col1,asc or ?order=col1,desc

type
number
active
boolean
includeLastSchema
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a content schema by ID

Authorizations:
bearer
path Parameters
organizationId
required
number
id
required
string

Responses

Response samples

Content type
application/json
{
  • "contentSchemaId": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "type": 0,
  • "active": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "contentSchemaVersionId": 0,
  • "schema": "string"
}

Update a content schema

Authorizations:
bearer
path Parameters
organizationId
required
number
id
required
string
Request Body schema: application/json
required
name
string
description
string
pictureUrl
string
type
number
active
boolean
schema
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "type": 0,
  • "active": true,
  • "schema": "string"
}

Response samples

Content type
application/json
{
  • "contentSchemaId": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "type": 0,
  • "active": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "contentSchemaVersionId": 0,
  • "schema": "string"
}

Delete a content schema

Authorizations:
bearer
path Parameters
id
required
string
organizationId
required
number

Responses

Response samples

Content type
application/json
true

Retrieve a content schema by ID and version

Authorizations:
bearer
path Parameters
organizationId
required
number
id
required
string
versionId
required
string

Responses

Response samples

Content type
application/json
{
  • "contentSchemaId": 0,
  • "organizationId": 0,
  • "name": "string",
  • "description": "string",
  • "pictureUrl": "string",
  • "type": 0,
  • "active": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "contentSchemaVersionId": 0,
  • "schema": "string"
}