Skip to main content

Payment

Overview​

The payment object defines how a member pays using loyalty assets such as points or credit. It is used within /payment and /transaction calls to either apply a payment or cancel a previous one.

When to Use This Object​

Include a payment object when:

  • A member is redeeming loyalty points or credit during a transaction
  • You are canceling a previously confirmed loyalty payment
  • A payment breakdown is required in a submitted transaction payload

Field Reference​

FieldTypeRequiredDescription
actionstringYes"pay" or "cancel" — defines if this is a new payment or a cancellation
amountnumberYesAmount to be processed (positive for pay, negative for cancel)
confirmationCodestringConditionalRequired only for cancel — must match a previously issued payment

Example: Payment Request​

{
  "payment": {
    "action": "pay",
    "amount": 1000
  }
}

Example: Payment Cancellation​

{
  "payment": {
    "action": "cancel",
    "confirmationCode": "ABC123XYZ",
    "amount": -1000
  }
}

Notes​

  • For "pay" actions, the amount must be positive
  • For "cancel" actions, the amount must be negative and a valid confirmationCode must be provided
  • This object is required in /payment endpoint calls and may be embedded in /transaction calls for reporting purposes
  • Member pays partially with points and the rest with card
  • Member cancels a previous payment, and their balance is refunded
  • Detailed loyalty payment tracking for reporting or audit purposes