๐Ÿ’ณ Transactions API: How to Use It

๐Ÿ” What is the Transactions API?

The Transactions API v1 allows you to retrieve expense data generated by Clara cards within your organization. Each transaction includes metadata such as amount, currency, date, merchant, and the associated user and card.

This version is read-only, ideal for use cases like:

  • Expense reconciliation
  • Transaction history visualization
  • Internal reporting and dashboards

๐Ÿ†š Note: For enhanced filtering or expanded metadata, consider using Transactions API v2.


๐Ÿ“Œ Available Endpoints

OperationEndpointMethod
Find all transactions/v1/transactionsGET
Find transaction by UUID/v1/transactions/{uuid}GET

1๏ธโƒฃ Find all transactions

Use this endpoint to fetch a list of all transactions. The response is paginated and includes key information about each transaction such as amount, status, category, and user.

๐Ÿ”— Endpoint

GET /v1/transactions

๐Ÿ“ค cURL Request

curl -X GET \
"https://public-api.mx.clara.com/api/v1/transactions" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

๐Ÿ“ฅ Sample JSON Response

[
 [
  {
    "uuid": "txn-001",
    "amount": 1250.50,
    "currency": "MXN",
    "status": "APPROVED",
    "merchant": "Amazon",
    "category": "Office Supplies",
    "userUuid": "user-001",
    "cardUuid": "card-001",
    "createdAt": "2025-06-15T12:30:00Z"
  }
]


2๏ธโƒฃ Find transaction by UUID

Use this endpoint to get full details of a specific transaction by its UUID. This is useful for audit views, drill-downs in dashboards, or reconciliation workflows.

๐Ÿ”— Endpoint

GET /v1/transactions/{uuid}

๐Ÿ“ค cURL Request

curl -X GET \
"https://public-api.mx.clara.com/api/v1/transactions/txn-001" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

๐Ÿ“ฅ Sample JSON Response

{
  "uuid": "txn-001",
  "amount": 1250.50,
  "currency": "MXN",
  "status": "APPROVED",
  "merchant": "Amazon",
  "category": "Office Supplies",
  "description": "Purchase of printer toner",
  "userUuid": "user-001",
  "cardUuid": "card-001",
  "createdAt": "2025-06-15T12:30:00Z"
}

๐Ÿ’ก Tip: Use the userUuid and cardUuid fields to join transaction data with user and card profiles for enriched analysis.

โš ๏ธ Note: This API is paginated. Make sure to handle pagination parameters when retrieving large datasets.