Reverse event

cURL

curl --request POST \
  --url https://app.masivo.ai/api/storefront/v1/behavior/events/{eventId}/reverse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "PURCHASE",
    "data": {},
    "fulfilled": true,
    "reserve": 123,
    "queue_message_id": "<string>",
    "rewarding_campaigns": "<array>",
    "status": "PENDING",
    "result": {
      "wallet": {},
      "customer": {},
      "gift_card": [
        {
          "code": "<string>",
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "rewarded_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "expired_at": "2023-11-07T05:31:56Z",
          "redeemed_at": "2023-11-07T05:31:56Z"
        }
      ],
      "accumulations": [
        {
          "amount": 123,
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "issued_at": "2023-11-07T05:31:56Z",
          "expiration_date": "2023-11-07T05:31:56Z",
          "reservation_expires_at": "2023-11-07T05:31:56Z"
        }
      ],
      "redemptions": [
        {
          "amount": 123,
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "issued_at": "2023-11-07T05:31:56Z",
          "expiration_date": "2023-11-07T05:31:56Z",
          "reservation_expires_at": "2023-11-07T05:31:56Z"
        }
      ],
      "transactions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "brand_id": "<string>",
          "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "store_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "funded_by": "MARKETING",
          "event_type": "PURCHASE",
          "reward_type": "POINTS",
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "cost": 123,
          "details": "<string>",
          "type": "ACCUMULATION",
          "receiver_id": "<string>",
          "sender_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "issued_at": "2023-11-07T05:31:56Z",
          "attributes": {
            "line": {
              "amount": 123,
              "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "issued_at": "2023-11-07T05:31:56Z",
              "expiration_date": "2023-11-07T05:31:56Z",
              "reservation_expires_at": "2023-11-07T05:31:56Z"
            },
            "campaign_name": "<string>"
          },
          "metadata": {}
        }
      ],
      "customer_by_tier": [
        {}
      ]
    },
    "issued_at": "2023-11-07T05:31:56Z",
    "processing_at": "2023-11-07T05:31:56Z",
    "resolved_at": "2023-11-07T05:31:56Z",
    "cancelled_at": "2023-11-07T05:31:56Z",
    "expired_at": "2023-11-07T05:31:56Z",
    "reversed_at": "2023-11-07T05:31:56Z"
  }
}

POST

behavior

events

{eventId}

reverse

cURL

curl --request POST \
  --url https://app.masivo.ai/api/storefront/v1/behavior/events/{eventId}/reverse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "PURCHASE",
    "data": {},
    "fulfilled": true,
    "reserve": 123,
    "queue_message_id": "<string>",
    "rewarding_campaigns": "<array>",
    "status": "PENDING",
    "result": {
      "wallet": {},
      "customer": {},
      "gift_card": [
        {
          "code": "<string>",
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "rewarded_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "expired_at": "2023-11-07T05:31:56Z",
          "redeemed_at": "2023-11-07T05:31:56Z"
        }
      ],
      "accumulations": [
        {
          "amount": 123,
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "issued_at": "2023-11-07T05:31:56Z",
          "expiration_date": "2023-11-07T05:31:56Z",
          "reservation_expires_at": "2023-11-07T05:31:56Z"
        }
      ],
      "redemptions": [
        {
          "amount": 123,
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "issued_at": "2023-11-07T05:31:56Z",
          "expiration_date": "2023-11-07T05:31:56Z",
          "reservation_expires_at": "2023-11-07T05:31:56Z"
        }
      ],
      "transactions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "brand_id": "<string>",
          "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "store_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "funded_by": "MARKETING",
          "event_type": "PURCHASE",
          "reward_type": "POINTS",
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "cost": 123,
          "details": "<string>",
          "type": "ACCUMULATION",
          "receiver_id": "<string>",
          "sender_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "issued_at": "2023-11-07T05:31:56Z",
          "attributes": {
            "line": {
              "amount": 123,
              "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "issued_at": "2023-11-07T05:31:56Z",
              "expiration_date": "2023-11-07T05:31:56Z",
              "reservation_expires_at": "2023-11-07T05:31:56Z"
            },
            "campaign_name": "<string>"
          },
          "metadata": {}
        }
      ],
      "customer_by_tier": [
        {}
      ]
    },
    "issued_at": "2023-11-07T05:31:56Z",
    "processing_at": "2023-11-07T05:31:56Z",
    "resolved_at": "2023-11-07T05:31:56Z",
    "cancelled_at": "2023-11-07T05:31:56Z",
    "expired_at": "2023-11-07T05:31:56Z",
    "reversed_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

eventId

string<uuid>

required

The event unique identifier

Body

application/json

reason

string

required

The reason to reverse the event

Response

Event reversed successfully

data

object

Show child attributes

data.id

string<uuid>

The event internal unique identifier

data.customer_id

string<uuid>

The customer id of the event

data.type

string

The type of the event

Example:

"PURCHASE"

data.data

object

The data used in the event

data.fulfilled

boolean

If the event was fulfilled.

data.reserve

number<int2>

The number of days to reserve the rewards

data.queue_message_id

string

The message id in the queue

data.rewarding_campaigns

array

The campaigns that rewarded the event including the rules that matched

data.status

enum<string>

The status of the event

Available options:

PENDING,

PROCESSING,

FAILED,

RESOLVED,

CANCELLED,

EXPIRED,

REVERSED

data.result

object

The result of the event

Show child attributes

data.result.wallet

object

The wallet state after the event

data.result.customer

object

The customer state after the event

data.result.gift_card

object[]

Gift cards related to the event

Show child attributes

data.result.gift_card.code

string

required

The gift card code to use in the store

data.result.gift_card.reward_id

string<uuid>

required

The reward id of the gift card

data.result.gift_card.customer_id

string<uuid>

required

The customer id that owns the gift card

data.result.gift_card.rewarded_at

string<date-time>

required

The date when the gift card was issued to a customer

data.result.gift_card.description

string

The gift card description

data.result.gift_card.expired_at

string<date-time> | null

The expiration date of the gift card

data.result.gift_card.redeemed_at

string<date-time> | null

The date when the gift card was redeemed

data.result.accumulations

object[]

Total accumulations after the event

Show child attributes

data.result.accumulations.amount

number

The amount of the line

data.result.accumulations.reward_id

string<uuid>

The reward id of the line

data.result.accumulations.campaign_id

string<uuid> | null

The campaign id of the line

data.result.accumulations.brand_id

string<uuid> | null

The id of the brand that originated the line

data.result.accumulations.issued_at

string<date-time>

The date when the line was issued

data.result.accumulations.expiration_date

string<date-time>

The expiration date of the line

data.result.accumulations.reservation_expires_at

string<date-time> | null

The reservation expiration date of the line

data.result.redemptions

object[]

Redemptions made during the event

Show child attributes

data.result.redemptions.amount

number

The amount of the line

data.result.redemptions.reward_id

string<uuid>

The reward id of the line

data.result.redemptions.campaign_id

string<uuid> | null

The campaign id of the line

data.result.redemptions.brand_id

string<uuid> | null

The id of the brand that originated the line

data.result.redemptions.issued_at

string<date-time>

The date when the line was issued

data.result.redemptions.expiration_date

string<date-time>

The expiration date of the line

data.result.redemptions.reservation_expires_at

string<date-time> | null

The reservation expiration date of the line

data.result.transactions

object[]

Total transactions after the event

Show child attributes

data.result.transactions.id

string<uuid>

The transaction internal unique identifier

data.result.transactions.brand_id

string | null

The brand id of the transaction

data.result.transactions.event_id

string<uuid> | null

The id of the event the created the transaction

data.result.transactions.campaign_id

string<uuid> | null

The id of the campaign that created the transaction

data.result.transactions.channel_id

string<uuid> | null

The id of the channel that created the transaction

data.result.transactions.store_id

string<uuid> | null

The id of the store that created the transaction

data.result.transactions.funded_by

string | null

Who funded the rewards used in this transaction

Example:

"MARKETING"

data.result.transactions.event_type

string

The type of the event that created the transaction

Example:

"PURCHASE"

data.result.transactions.reward_type

enum<string>

The type of the reward used in the transaction

Available options:

POINTS,

DISCOUNT,

GIFT_CARD,

PRODUCT

data.result.transactions.reward_id

string<uuid>

The reward id of the transaction

data.result.transactions.amount

number

The amount of the transaction

data.result.transactions.cost

number | null

The cost of the rewards used in the transaction

data.result.transactions.details

string

The explanation of why transaction was created

data.result.transactions.type

enum<string>

The type of the transaction

Available options:

ACCUMULATION,

REDEMPTION,

EXPIRATION,

MIGRATION,

TRANSFER,

REVERSAL

data.result.transactions.receiver_id

string

The receiver id of the transaction

data.result.transactions.sender_id

string

The sender id of the transaction

data.result.transactions.created_at

string<date-time>

The date when the transaction was created

data.result.transactions.issued_at

string<date-time>

The date when the transaction was issued

data.result.transactions.attributes

object

The attributes of the transaction

Show child attributes

data.result.transactions.attributes.line

object

required

The line used to create the transaction

Show child attributes

data.result.transactions.attributes.line.amount

number

The amount of the line

data.result.transactions.attributes.line.reward_id

string<uuid>

The reward id of the line

data.result.transactions.attributes.line.campaign_id

string<uuid> | null

The campaign id of the line

data.result.transactions.attributes.line.brand_id

string<uuid> | null

The id of the brand that originated the line

data.result.transactions.attributes.line.issued_at

string<date-time>

The date when the line was issued

data.result.transactions.attributes.line.expiration_date

string<date-time>

The expiration date of the line

data.result.transactions.attributes.line.reservation_expires_at

string<date-time> | null

The reservation expiration date of the line

data.result.transactions.attributes.campaign_name

string

The name of the campaign that created the transaction

data.result.transactions.metadata

object

The metadata of the transaction

data.result.customer_by_tier

object[]

Customer tier changes resulting from the event

data.issued_at

string<date-time>

The date when the event was issued

data.processing_at

string<date-time> | null

The date when the event was processed

data.resolved_at

string<date-time> | null

The date when the event was resolved either succeed or failed

data.cancelled_at

string<date-time> | null

The date when the event was cancelled

data.expired_at

string<date-time> | null

The date when the event expired

data.reversed_at

string<date-time> | null

The date when the event was reversed

Fulfill event Preview order

⌘I

API Documentation

Endpoints

Guides

Resources

Authorizations

Path Parameters

Body

Response