Skip to main content
GET
/
api
/
canary
/
customers
/
{id}
/
transactions
Provides the full transaction history for a single customer’s “cash balance” (Pay-Ins, Purchases, Transfers).

​
Path Parameters

​
id
string
required
The unique identifier of the customer

​
Query Parameters

​
startDate
string
Filter transactions from this date (ISO 8601 format)
​
endDate
string
Filter transactions until this date (ISO 8601 format)
​
transactionType
string
Filter by transaction type (e.g., “pay_in”, “purchase”, “transfer”, “credit”, “debit”)
​
offset
number
Number of transactions to skip (default: 0)
​
limit
number
Maximum number of transactions to return (default: 50)

​
Response

​
Success
​
data
array
Array of transactions
​
pagination
object
Pagination information

​
Example Response

{
  "data": [
    {
      "id": "txn_001",
      "customerId": "customer_789",
      "type": "credit",
      "amount": 1000,
      "currency": "ZAR",
      "description": "Checkout session completed",
      "relatedEntityId": "checkout_sess_123",
      "relatedEntityType": "CheckoutSession",
      "balanceAfter": 5000,
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    },
    {
      "id": "txn_002",
      "customerId": "customer_789",
      "type": "purchase",
      "amount": -50,
      "currency": "ZAR",
      "description": "Purchase of Airtime",
      "relatedEntityId": "purchase_001",
      "relatedEntityType": "Purchase",
      "balanceAfter": 4950,
      "createdAt": "2025-01-15T11:00:00.000Z",
      "updatedAt": "2025-01-15T11:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 25,
    "hasMore": false
  }
}

​
Error Responses

​
Unauthorized
Invalid or missing authentication token
​
Not Found
Customer not found
​
Internal Server Error
An unexpected error occurred on the server

​
Authentication

This endpoint requires Bearer token authentication.