Skip to main content
GET
/
api
/
canary
/
customers
/
{id}
/
transactions
List Customer's Cash Transactions
curl --request GET \
  --url http://localhost:3000/api/canary/customers/{id}/transactions \
  --header 'Authorization: Bearer <token>'
{
  "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
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The unique identifier of the customer

Response

Successfully retrieved customer transactions

data
object[]
required
pagination
object
required