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/v10/invoices/transactions

List transactions

List all invoice transactions.

A transaction can be recorded manually by an Administrator (for example, an accountant) in the DreamApply portal, via the API or as part of a payment flow.

If a transaction was made using a payment gateway (for example, a credit card payment), the payment field is also populated. The payment status can be new,canceled,failed,captured. The captured field indicates a successful payment. Other statuses indicate various stages of the process or its failure.

The message field may contain a description of the failure/error.

Regardless of its type, each transaction has an ID. Transactions that have the payment field also have two more identifiers:

payment: The identifier local to DreamApply
external_id: May contain any identifier assigned by the used payment gateway, such as Pago Atenei, Stripe, PayPal and so on. This field can be used to look up and correlate payment records within the external payment system.

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

Parameters

Name	Required/Optional	Description	Notes
`byInvoiceIDs`	Optional	A list of invoice IDs.	[1]
`byInsertedSince`	Optional	An ISO 8601 datetime. Only shows transactions created after this date and time.
`byInsertedBefore`	Optional	An ISO 8601 datetime. Only shows transactions created before this date and time.
`byCollectedSince`	Optional	`YYYY-MM-DD`. Only shows transactions with the collection date later than this date.
`byCollectedBefore`	Optional	`YYYY-MM-DD`. Only shows transactions with the collection date earlier than this date.

Notes

Note [1]: Lists can be either comma or space separated. All list items are combined with logical OR operators, meaning a transaction is included if it matches any value in the list.

Example request

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

Response headers

Header	Value	Description
`Content-Type`	`application/json`	The media type of the resource
`Content-Length`	`1234`	The size of the response body in bytes
`X-Count`	`15`	The 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/v10/invoices/508",
    "inserted": "2025-10-17T13:12:13+00:00",
    "collected": "2025-10-17",
    "administrator": "/api/v10/administrators/10006",
    "payment": null
  },
  "28": {
    "id": 28,
    "amount": "120.00",
    "invoice": "/api/v10/invoices/497",
    "inserted": "2025-10-17T13:13:30+00:00",
    "collected": "2025-10-17",
    "administrator": "/api/v10/administrators/10006",
    "payment": null
  },
  "29": {
    "id": 29,
    "amount": "15.00",
    "invoice": "/api/v10/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"
      }
    }
  }
}