HomeGuidesRecipesAPI ReferenceChangelog
GuidesAPI ReferenceCustomer Help CenterLog In
API Reference

Introduction

Transactions track all movement of money in Xola. For any exchange of money from one user to another (e.g. consumer paid a seller), a new transaction is created. This is true even if the exchange of money happened offline (e.g. physical cash).

Transactions in Xola track movement in several directions:

  • From a traveler to the seller (creating a new booking)
  • From a seller back to the traveler (a refund)
  • From Xola to the seller (a payout)
  • From a seller to an affiliate (paying out commissions)

📘

Transactions are Immutable

Transactions once created are never modified. Once fetched you may cache transactions locally if required.

Transaction Types

Every transaction has a type attribute that indicates the nature of the transaction. Currently Xola has the following transaction types:

TypeDescription
purchaseThe traveler paid an amount to the seller for a purchase. This could reflect creation of a new purchase, or an additional charge on a pre-existing purchase.
purchase_affiliate
refundA purchase was refunded -- the seller refunded some money back to the traveler
depositThe traveler paid a deposit amount to the seller for a purchase.
balanceThe seller collected the balance amount from a deposit (which was previously collected towards a purchase).
payoutA payout was initiated from Xola to the seller's bank account. All payout transactions are reflected in the payouts report
auto_payoutAn automatic payout was initiated from Xola to the seller's bank account. All payout transactions are reflected in the payouts report
payout_adjust
affiliateReflects collecting payment or crediting an affiliate with an amount for their bookings.
modify
subscriptionXola charging the seller for their subscription fees. In this situation the seller's registered credit card would be charged.