v1

latestOpenAPI 3.0.1MIT2026-07-26286592.7 KB

Create Platform Transaction

Record completed sales from a platform calculation. For payment processors, this creates two transactions: one for the order and one for the fee. For marketplace providers or merchants of record, only the order transaction is created.

post/tax/platform/transactions

Headers

X-API-Version'2026-01-01' required

Request body

platform_calculation_idstring required

The ID of the platform calculation to convert to transactions

reference_order_idstring required

Your unique identifier for this order

reference_payment_idstring

Your unique identifier for the payment (optional)

transaction_processed_atnumber

Unix timestamp when the transaction was processed

Response

Platform transaction list response

objectstring

Example response

{
  "object": "list",
  "transactions": [
    {
      "object": "tax.transaction",
      "line_items": [
        {
          "product": {
            "reference_product_name": "Widget",
            "reference_line_item_id": "line_987654321",
            "reference_product_id": "p-1233543",
            "product_tax_code": "GENERAL_MERCHANDISE"
          },
          "tax_jurisdictions": [
            {
              "tax_rate": 0.07,
              "tax_due_decimal": 700,
              "rate_type": "GENERAL STATE SALES TAX",
              "tax_authority_name": "Tennessee",
              "tax_type": "SALES"
            }
          ],
          "quantity": 2,
          "tax_amount": 14,
          "amount_excluding_tax": 200,
          "amount_including_tax": 214
        }
      ]
    }
  ]
}