Reverse Earned Points

When a member cancels a purchase transaction or returns an order, this endpoint cancels all the points earned in that transaction.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Transaction details to reverse the earned points

activityTimestamp

string

required

Activity date (in UTC format). An activity could be enrolling a member, making a transaction, etc.

checkForDuplicateTransaction

integer

required

0 indicates the system allows duplicate and 1 indicates there is a validation in place to identify duplicates.

discountValue

number | null

required

Discount amount applied on the transaction.

entityReference

string

required

Unique name or ID of store (or entity) where the transaction took place.

Required string length: 3 - 15

fetchUpdatedMemberPointTotals

integer

required

A value of 1 indicates the total points (including the points earned in the latest transaction) are calculated and displayed to the member. A value of 0 indicates the total points are not calculated and the member is only notified if the earn is successful. The response is faster when the value is 0 because there is no calculations involved.

netAmount

number

required

Net transaction amount. Example - the net amount of item1 is 100.00 and net amount of item2 is 200.00. So, the netAmount is 300.00.

profileId

string

required

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync. profileId is generated as part of the Enroll Member endpoint - POST /members.

reverseTransactionExternalRef

string

required

External reference number of the transaction to be reversed

Required string length: 1 - 100

totalAmountPaid

number

required

Total amount paid for the items. For example, the amount paid for item1 is 100.00 and the amount of item2 is 200.00 so the total amount paid is 300.00.

totalTax

number

required

Final tax amount based on the number of items in the transaction. Example - the tax amount of item1 is 2.00; Tax amount of item2 is 2.00. The totalTax is 4.00.

transactionExternalReference

string

required

Order ID or receipt ID for the transaction (received from the store). This is needed to cancel or return an order.

Required string length: 1 - 100

transactionGrossAmount

number

required

Transaction gross amount. For example, gross amount of item1 is 50.00 and gross amount of item2 is 100.00, then transactionGrossAmount is 150.00

transactionTypeExternalReference

string

required

External reference for transaction type such purchase, return, or exchange (configurable as per requirement).

Required string length: 3 - 15

cancelAuditUser

string | null

Representative who cancelled the earn transaction.

Required string length: 1 - 100

discounts

object[]

Discount details.

Show child attributes

discounts.id

integer

required

Discount ID

discounts.value

number

required

Discount amount

discounts.description

string

Description of the discount.

discounts.type

string

Discount type (configurable).

Minimum length: 1

isCompanyUser

boolean

default:

false

true: Company user is running the endpoint <br /> false: Client user is running the endpoint.

issueAuditUser

string | null

Representative who issued the earn transaction.

Required string length: 1 - 100

reasonCode

string | null

Reason code to categorize transactions. A parent company can configure custom codes for their stores as required.

Required string length: 1 - 4

reasonDescription

string | null

When reason codes are not configured, store can make use of the reason description.

Required string length: 1 - 20

redemptionCode

string[] | null

Redemption code used to identify and link the rewards used in a specific transaction. This code is generated in the response of the Issue Variable Rewards endpoint - POST /api/v1/redeem/reward/issue.

setToPending

boolean

true: Points in Pending status <br /> false: Points in Active status. Note: The time period for Pending state is configurable.

transactionItems

object[]

Details of the transaction items to be reversed.

Show child attributes

transactionItems.grossAmount

number

required

Gross amount of the item, before discount

transactionItems.itemPrice

number

required

Item price

transactionItems.itemQuantity

integer

required

Item quantity

transactionItems.lineNumber

integer

required

Line number of the item in the overall transaction

transactionItems.netAmount

number

required

Item net amount, after any item-level discounts.

transactionItems.SKU

string

required

Stock Keeping Unit (SKU) of the item.

Required string length: 1 - 100

transactionItems.taxAmount

number

required

Tax amount of the item

transactionItems.totalAmountPaid

number

required

Amount paid for the item

transactionItems.categories

string[]

transactionItems.couponCodes

string[]

transactionItems.discounts

object[]

Details of item-level discounts

Show child attributes

transactionItems.discounts.id

integer

required

Discount ID

transactionItems.discounts.value

number

required

Discount amount

transactionItems.discounts.description

string

Description of the discount.

transactionItems.discounts.type

string

Discount type (configurable).

Minimum length: 1

transactionItems.itemName

string

Item name

Minimum length: 1

transactionItems.UOM

string

Unit of Measurement (UOM)

Minimum length: 1

Response

200 - application/json

Metadata for the Earn Reverse response

data

object

Earn Reverse response details

Show child attributes

data.profileId

string

required

Profile ID of member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

data.transactionNumber

string

required

Transaction number. This is same as the transactionExternalReference and indicates a unique order ID or the receipt ID.

Minimum length: 1

data.transactionType

enum<string>

required

This field specifies the type of transaction activity, such as Earn Transaction, Burn Transaction, Earn Reverse Transaction and so on

Available options:

EARN,

BURN,

EXPIRY,

EARN_REVERSE,

BURN_REVERSE,

ADJUSTMENT,

DEDUCT,

TRANSFER,

MERGE,

FORFEITED,

CONVERT,

UNMERGE

data.activityTimestamp

string

Transaction activity time, in UTC format.

data.basePoints

number

Base points reversed in this transaction

data.bonusPoints

number

Bonus points reversed in this transaction

data.cancelAuditUser

string | null

Representative who cancelled the earn transaction.

Minimum length: 1

data.currentPointsBalance

number

Points available in the member's account after this transaction.

data.deviceId

string

Device ID used to reverse the transaction

data.discounts

object[]

Discount details.

Show child attributes

data.discounts.id

integer

required

Discount ID

data.discounts.value

number

required

Discount amount

data.discounts.description

string

Description of the discount.

data.discounts.type

string

Discount type (configurable).

Minimum length: 1

data.discountValue

number

Discount amount for this transaction.

data.issueAuditUser

string | null

Representative who issued the earn transaction.

Minimum length: 1

data.points

number

Total points reversed in this transaction.

data.promotionalPoints

number

Promotional points reversed in this transaction

data.reasonCode

string

Reason code to categorize transactions. A parent company can configure custom codes for their stores as required.

Minimum length: 1

data.reasonDescription

string

When reason codes are not configured, store can make use of the reason description to add notes on the transaction.

Minimum length: 1

data.rewards

object[]

Details of the variable rewards.

Show child attributes

data.rewards.core_rule_id

integer

ID of the core rule based on which the rewards are generated.

data.rewards.reward_id

integer

Variable reward IDs (also referred to as reward certificate). Note:Multiple rewards can be used a transaction.

data.rewards.reward_portion

number

Total reward amount.

data.totalAmountPaid

number

Total amount paid for the items. For example, the amount paid for item1 is 100.00 and the amount of item2 is 200.00 so the total amount paid is 300.00.

data.totalTax

number

Total tax applied on items eligible for earning points.

data.transactionActivityType

string

Configurable alias for the transactionType

data.transactionCode

string

Transaction Code

data.transactionDateTime

string

Transaction date, in UTC format.

data.transactionEntityReference

string

Reference to the entity where the transaction occurred

Minimum length: 1

data.transactionExternalReference

string

Order ID or receipt ID for the transaction (received from the store). This is unique and needed to cancel or return an order.

Minimum length: 1

data.transactionItems

object[]

Details of the reversed transaction items

Show child attributes

data.transactionItems.categories

string[]

required

data.transactionItems.grossAmount

number

required

Gross amount of the item, before discount

data.transactionItems.itemPrice

number

required

Item price

data.transactionItems.itemQuantity

integer

required

Item quantity.

data.transactionItems.lineNumber

integer

required

Line number of the item in the overall transaction

data.transactionItems.netAmount

number

required

Item net amount, after any item-level discounts.

data.transactionItems.SKU

string

required

Stock Keeping Unit (SKU) of item

Required string length: 1 - 100

data.transactionItems.taxAmount

number

required

Tax amount of item

data.transactionItems.couponCodes

string[]

data.transactionItems.discounts

object[]

Details of item-level discounts

Show child attributes

data.transactionItems.discounts.id

integer

required

Discount ID

data.transactionItems.discounts.value

number

required

Discount amount

data.transactionItems.discounts.description

string

Description of the discount.

data.transactionItems.discounts.type

string

Discount type (configurable).

Minimum length: 1

data.transactionItems.itemName

string

Item name

Minimum length: 1

data.transactionItems.UOM

string

Unit of Measurement (UOM)

Minimum length: 1

data.transactionNetAmount

number

Net total amount of the transaction.

data.transactionTypeExternalReference

string

External reference for the transaction type such as purchase, return, or exchange. Supports any value as configured by store.

errors

object

In a successful response, this is always a blank object

message

string

Message corresponding to the status code.

status

integer

Status code for the call