Create Transaction
Creates a new transaction with one or more detail line items.
Last updated: April 9, 2026
Create Transaction
POST /siren/v1/transactions
Creates a new transaction with one or more detail line items. The transaction is created with a status of complete.
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
details | object[] | Yes | Array of detail line item objects (see below) |
bindingId | string or integer | No | External reference ID for mapping to a source system |
bindingDataType | string | No | External reference type identifier |
Each object in the details array accepts:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Display name for the line item |
description | string | No | Longer description |
type | string | No | Type identifier (e.g., credit, debit) |
value | integer | Yes | Value in smallest currency unit (e.g., cents) |
quantity | integer | No | Quantity (defaults to 1) |
units | string | No | Currency code or unit type (e.g., USD) |
attributes | object | No | Additional key-value metadata |
Example Request:
{
"details": [
{
"name": "Manual Credit",
"description": "Manual credit for collaborator",
"type": "credit",
"value": 5000,
"quantity": 1,
"units": "USD"
}
]
}
Example Response:
{
"id": 102,
"status": "complete",
"dateCreated": "2026-04-08T12:00:00Z"
}
Creation may be rejected by event listeners if the details do not pass validation. In that case, the endpoint returns 400 with an error message.