Invoice transaction

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single invoice transaction.

URI

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

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

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The transaction data was successfully returned
`404 Not Found`	The 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"
 }
 }
}

Invoice transactions on DreamApply Knowledge Base

Invoice transaction

GET Get a transaction

Example request

Response headers

Response codes

Example response

Get a transaction