Retrieving Transactions and Payments

See an example request below:

curl --location 'https://api.sandbox.caliza.com/core-api/v1/transactions?beneficiaryId=69261109adcc7b2db705a123&status=SUCCEEDED&fromDate=2025-01-01&toDate=2025-12-31&page=0&size=20&sort=createdDate,desc' \
--header 'Authorization: Bearer YOUR_TOKEN'

Where:

• beneficiaryId: The ID of the beneficiary to filter transactions for.
• fromCurrency: A list of source currency codes to filter by (e.g., USDC, USD). Pass multiple values as repeated query parameters.
• toCurrency: A list of destination currency codes to filter by (e.g., USD, BRL). Pass multiple values as repeated query parameters.
• status: The transaction status to filter by (e.g., CREATED, PROCESSING, SUCCEEDED, FAILED, EXPIRED, PAYMENT_SENT, PAYMENT_COMPLETED, PROCESSED_BY_INTERMEDIARY_BANK).
• transactionId: The ID of a specific transaction to retrieve.
• fromDate: The start date for the date range filter (e.g., 2025-01-01).
• toDate: The end date for the date range filter (e.g., 2025-12-31).
• minAmount: The minimum transaction amount to filter by.
• maxAmount: The maximum transaction amount to filter by.
• page: The page number to retrieve (zero-based, default 0).
• size: The number of items per page (default 20).
• sort: The sort criteria in the format property,direction (e.g., createdDate,desc).

All query parameters are optional. If no filters are provided, all transactions for your account are returned.

The response includes a paginated list of transactions. The response should look like this:

{
  "content": [
    {
      "id": "5d097212-9902-4d86-beec-c578640105f4",
      "simulationId": "34c9dfe7-12da-4119-8beb-4db895c01a47",
      "beneficiaryId": "69261109adcc7b2db705a123",
      "from": {
        "currencyCode": "USDC",
        "value": 500.00
      },
      "to": {
        "currencyCode": "USD",
        "value": 495.00
      },
      "status": "SUCCEEDED",
      "transactionDetails": {
        "conversionDetails": {
          "effectiveTransactionValue": 495.00,
          "marketExchangeRate": 1.00
        },
        "feeDetails": {
          "totalFees": {
            "currencyCode": "USDC",
            "value": 5.00
          },
          "integratorFee": {
            "currencyCode": "USDC",
            "value": 0.00
          },
          "taxes": {
            "currencyCode": "USDC",
            "value": 0.00
          }
        }
      },
      "blockchainInfo": null,
      "localInfo": null,
      "efx": false,
      "createdDate": "2025-11-27T15:00:00Z",
      "lastModifiedDate": "2025-11-27T15:05:00Z",
      "settledAt": "2025-11-27T15:05:00Z"
    }
  ],
  "pageable": {
    "pageNumber": 0,
    "pageSize": 20,
    "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
    },
    "offset": 0,
    "paged": true,
    "unpaged": false
  },
  "totalPages": 1,
  "totalElements": 1,
  "last": true,
  "first": true,
  "size": 20,
  "number": 0,
  "numberOfElements": 1,
  "sort": {
    "sorted": true,
    "unsorted": false,
    "empty": false
  },
  "empty": false
}

Where:

• content: An array of transaction objects matching the filter criteria.
• id: The unique identifier for the transaction.
• simulationId: The ID of the simulation associated with the transaction.
• beneficiaryId: The ID of the beneficiary associated with the transaction.
• from: An object containing the source currency code and value.
• to: An object containing the destination currency code and value.
• status: The current status of the transaction (e.g., CREATED, PROCESSING, SUCCEEDED, FAILED).
• transactionDetails: An object containing conversion details and fee breakdown.
• blockchainInfo: An object containing blockchain-related information (if applicable).
• localInfo: An object containing local payment information (if applicable).
• efx: A boolean indicating whether this is an EFX transaction.
• createdDate: The date and time when the transaction was created.
• lastModifiedDate: The date and time when the transaction was last modified.
• settledAt: The date and time when the transaction was settled (if applicable).
• totalPages: The total number of pages available.
• totalElements: The total number of transactions matching the filter criteria.