Transaction (v3)

Create a Transaction

Creates a Transaction using the v3 API format. Either a message or summary must be provided, but not both. For guidance on how to use this endpoint, see the <a href="https://docs.orderful.com/docs/create-a-transaction" target="_blank">Create a Transaction guide</a>.

post/v3/transactions

Request

Base URL
https://api.orderful.com
Auth
API key in header orderful-api-key
TypeScript
https://skmtc.dev/orderful/apis/orderful-api/docs/v3/transactions/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

orderful-api-keystring required

Your Orderful API key.

Request body

stream'TEST' | 'LIVE' required

Name of stream to create the transaction on.

messagestring json

Transaction document in the structure defined by the specified type. Either message or summary must be provided, but not both.

Response

Transaction created successfully.

idstring required

The transaction ID.

Changes

No recorded changes to this operation across all 2 revisions of this API.