API V2 Route: Transactions

Last updated: October 5, 2026

General Details:

Endpoint /api/v2/transactions and /api/v2/transactions/<id>
Headers Authorization: <JWT>
HTTP Methods GET
Request Body Format N/A
Response Body Format JSON
Required Scopes TRANSACTIONS_GET

 

Supported Request Filters:

These filters should be query parts in the URL string and follow the standard pattern of <baseUrl>?<key>=<filter>&...

Field Name Filter Type Notes
dateCreated date or Date Filter An ISO date string or a complex Date Filter can be utilized

 

API Response:

Field Name Data Type Notes
id string Globally unique identifier
dateCreated date string ISO date string
amount string A string representation of a number with two decimal places
dateEffective date string  
dateBillingStart date string The billing start date used in proration logic
dateBillingEnd date string The billing end date used in proration logic
isRefunded boolean If the transaction has been refunded
isProrated boolean If the transaction is a prorated amount
description string  
recipient ProfileThin  
issuer ProfileThin or null The value may be null if the transaction was generated automatically 
costCode CostCodeThin  
cycle CycleThin or null The value may be null if the transaction was created by an admin and the admin explicitly removed the link to a Cycle
originalTransactionId string If a Transaction was refunded after 2026-03-27, this value will be populated

 

Example Response:

{
    "entities": [
        {
            "id": "1",
            "dateCreated": "2025-09-25T13:31:55.357Z",
            "amount": "10.00",
            "dateEffective": "",
            "dateBillingStart": "",
            "dateBillingEnd": "",
            "isRefund": false,
            "isProrated": false,
            "description": "",
            "recipient": {
                "id": "12",
                "name": "Myron Bashirian",
                "sisId": "rxvd6"
            },
            "issuer": {
                "id": "11",
                "name": "Lela Hoeger",
                "sisId": "3gvg8"
            },
            "costCode": {
                "id": "2",
                "name": "Lost key fee",
                "code": "LKF-001"
            },
            "cycle": null
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1759520782000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1759520783000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 1000
        }
    }
}