Transactions

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a list of created transactions.

URI
/api/v9/invoices/transactions

List transactions

Get a list of transactions. A transaction may be recorded by an administrator manually in the UI (for example, an accountant), it may be recorded via the API, or it may be recorded as part of a payment flow.

If a transaction was made using a payment gateway (a credit card payment, for instance), the payment element is also populated. The payment status can be new,canceled,failed,captured. From these statuses captured designates a successful payment, while others indicate various stages of the process (or failure). The message element may contain a description of the failure/error.

Notice that each transaction has an ID (regardless of type), while transactions that have a “payment”, also have two more identifiers: payment and external_id. The payment identifier is local to DreamApply, while the external_id may contain any identifier assigned by the payment gateway in use (such as Pago Atenei, Stripe, PayPal etc.). This external_id can be used to look up and correlate payment records within the external payment system.

Syntax
GET /api/v9/invoices/transactions
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Name	Required/Optional	Description	Notes
`byInvoiceIDs`	Optional	List of invoice IDs.	[1]
`byInsertedSince`	Optional	ISO 8601 datetime. Only show transactions inserted after this.
`byInsertedBefore`	Optional	ISO 8601 datetime. Only show transactions inserted before this.
`byCollectedSince`	Optional	`YYYY-MM-DD`. Only show transactions with the collection date later than this.
`byCollectedBefore`	Optional	`YYYY-MM-DD`. Only show transactions with the collection date earlier than this.

Notes

Note [1]: Lists can be either comma or space separated. All list items are combined with logical OR operators — in other words an application is considered matching if it matches to any of the values in the list.

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/invoices/transactions?byCollectedSince=2025-10-10"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`15`	Number of created transactions

Response codes

Response code	Description
`200 OK`	The list of transactions was successfully returned

Example response

Response
{
  "27": {
    "id": 27,
    "amount": "20.00",
    "invoice": "/api/v9/invoices/508",
    "inserted": "2025-10-17T13:12:13+00:00",
    "collected": "2025-10-17",
    "administrator": "/api/v9/administrators/10006",
    "payment": null
  },
  "28": {
    "id": 28,
    "amount": "120.00",
    "invoice": "/api/v9/invoices/497",
    "inserted": "2025-10-17T13:13:30+00:00",
    "collected": "2025-10-17",
    "administrator": "/api/v9/administrators/10006",
    "payment": null
  },
  "29": {
    "id": 29,
    "amount": "15.00",
    "invoice": "/api/v9/invoices/532",
    "inserted": "2025-12-16T09:57:11+00:00",
    "collected": "2025-12-16",
    "administrator": null,
    "payment": {
      "payment": "01KCK9DZXPE8C82F5AE0AV955F",
      "external_id": "pi_3Sev0C3BsCbItDpn0rx0zvsW",
      "status": "captured",
      "message": null,
      "inserted": "2025-12-16T09:56:28+00:00",
      "updated": "2025-12-16T09:57:11+00:00",
      "gateway": {
        "id": 39,
        "name": "Stripe",
        "adapter": "Stripe"
      }
    }
  }
}

Invoice series

Transaction