Payments

Payments track monetary transactions in non-commerce systems like fintech platforms, SaaS subscriptions, bill payments, and service providers. Unlike orders (products), payments handle service-based transactions.

Payment Structure

Core Fields

Field	Type	Description
`customerId`	String	Unique customer identifier
`paymentId`	String	Your unique payment/transaction ID
`paymentDate`	String (ISO 8601)	When payment was processed
`totalPaid`	Number	Final amount paid (after discounts)
`totalAmount`	Number	Original amount (before discounts)
`totalDiscount`	Number	Total discount applied
`totalProcessingFees`	Number	Processing/transaction fees
`totalTax`	Number	Tax amount
`channel`	String	Source: mobile, web, pos, callcenter

Payment Details (Services)

Array of services:

Field	Type	Description
`serviceId`	String	Unique service identifier
`serviceName`	String	Human-readable service name
`serviceProvider`	String	Company providing the service
`amount`	Number	Service cost before tax/discount
`tax`	Number	Tax on this service
`discount`	Number	Discount on this service
`category`	Array	Service categories
`tags`	Array	Service tags

Example Payment

{
  "customerId": "customer_123",
  "paymentId": "PAY_456789",
  "paymentDate": "2024-10-16T08:13:29.290Z",
  "totalPaid": 100.00,
  "totalAmount": 120.00,
  "totalDiscount": 20.00,
  "paymentDetails": [
    {
      "serviceId": "ELEC_001",
      "serviceName": "Electricity Bill",
      "serviceProvider": "PowerCo",
      "amount": 100.00,
      "category": ["Utilities"]
    }
  ]
}

Payments vs Orders

Aspect	Payments	Orders
Use Case	Bill payments, subscriptions, services	Product purchases, e-commerce
Structure	`paymentDetails` (services)	`lineItems` (products)
Industries	Fintech, SaaS, utilities	E-commerce, retail
Common Fields	`serviceProvider`, `processingFees`	`sku`, `vendor`, `shipping`

Redemption During Payments

Redeem Points

{
  "redemption": {
    "pointsHoldReference": "hold_ref_abc123"
  }
}

Payment Tracking API

API endpoint documentation

Payment Handling Tutorial

Implementation guide

Getting Started

General

Experiences

More

Payment Structure

Core Fields

Payment Details (Services)

Example Payment

Payments vs Orders

Redemption During Payments

Redeem Points

Payment Tracking API

Payment Handling Tutorial

​Payment Structure

​Core Fields

​Payment Details (Services)

​Example Payment

​Payments vs Orders

​Redemption During Payments

​Redeem Points

​Related Resources

Payment Tracking API

Payment Handling Tutorial

Payment Structure

Core Fields

Payment Details (Services)

Example Payment

Payments vs Orders

Redemption During Payments

Redeem Points

Related Resources