v1

latestOpenAPI 3.0.02026-07-2421110121.4 KB
Transaction (v3)

Create a raw Transaction

Creates a Transaction from a raw document. The request body should contain the raw document content (e.g. X12, XML, CSV). Routing metadata is provided via request headers rather than in the body.

🚧 Try It! playground limitation

The in-page Try It! playground on this reference can only exercise application/json request bodies. If you are testing or experimenting with application/xml, text/xml, text/csv, application/pdf, image/jpeg, or text/plain payloads, use cURL or an HTTP client such as Postman for your ad-hoc requests. Your production integration is unaffected — this applies only to the in-browser Try It! tool. The endpoint itself accepts every supported content type from any HTTP client.

post/v3/transactions/raw

Headers

orderful-business-numberstring required

A business reference number for the Transaction.

orderful-stream'test' | 'live' required

The stream for the Transaction.

orderful-transaction-typestring required

The Transaction Type name.

orderful-receiver-idstring required

The ISA ID of the receiver.

orderful-sender-idstring required

The ISA ID of the sender.

Content-Type'application/json' | 'application/xml' | 'text/xml' | 'text/csv' | 'application/pdf' | 'image/jpeg' | 'text/plain' required

The content type of the raw document. Supported types: application/json, application/xml, text/xml, text/csv, application/pdf, image/jpeg, text/plain.

Request body

string json required

Response

idstring required

The transaction ID.