Siren

Create Transaction

Creates a new transaction with one or more detail line items.

Last updated: October 26, 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:

FieldTypeRequiredDescription
detailsobject[]YesArray of detail line item objects (see below)
bindingIdstring or integerNoExternal reference ID for mapping to a source system
bindingDataTypestringNoExternal reference type identifier

Each object in the details array accepts:

FieldTypeRequiredDescription
namestringYesDisplay name for the line item
descriptionstringNoLonger description
typestringNoType identifier (e.g., credit, debit)
valueintegerYesValue at the currency’s stored scale (hundredths for money, so $19.99 is 1999). Each line, and the lines added up for each currency, can’t pass the currency’s limit, as Maximum amounts describes
quantityintegerNoQuantity (defaults to 1)
unitsstringNoCurrency code or unit type (e.g., USD)
attributesobjectNoAdditional 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.

Your privacy choices

Account, checkout and chat you request work without optional tracking. Choose whether to allow these other uses on this website.

You can change or withdraw your choices at any time using “Privacy choices.” We remember your choice for 180 days. Read our privacy policy.