Skip to main content
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

FieldTypeDescription
customerIdStringUnique customer identifier
paymentIdStringYour unique payment/transaction ID
paymentDateString (ISO 8601)When payment was processed
totalPaidNumberFinal amount paid (after discounts)
totalAmountNumberOriginal amount (before discounts)
totalDiscountNumberTotal discount applied
totalProcessingFeesNumberProcessing/transaction fees
totalTaxNumberTax amount
channelStringSource: mobile, web, pos, callcenter

​
Payment Details (Services)

Array of services:
FieldTypeDescription
serviceIdStringUnique service identifier
serviceNameStringHuman-readable service name
serviceProviderStringCompany providing the service
amountNumberService cost before tax/discount
taxNumberTax on this service
discountNumberDiscount on this service
categoryArrayService categories
tagsArrayService 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

AspectPaymentsOrders
Use CaseBill payments, subscriptions, servicesProduct purchases, e-commerce
StructurepaymentDetails (services)lineItems (products)
IndustriesFintech, SaaS, utilitiesE-commerce, retail
Common FieldsserviceProvider, processingFeessku, vendor, shipping

​
Redemption During Payments

​
Redeem Points

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

Payment Tracking API

API endpoint documentation

Payment Handling Tutorial

Implementation guide