Invoice transaction

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

Represents a single invoice transaction.

URI
/api/v9/invoices/ID/transactions/ID

GET Get a transaction

Return information about a transaction, identified by the invoice ID and the transaction ID.

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

Example request

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

Response headers

HeaderValueDescription
Content-Typeapplication/jsonMedia type of the resource
Content-Length1234Size of the response body in bytes

Response codes

Response codeDescription
200 OKThe transaction data was successfully returned
404 Not FoundThe transaction was not found

Example response

Response
{
  "id": 44,
  "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"
    }
  }
}

Previous

Invoice transactions