Transaction

Create a Transaction

Creates a Transaction. Only one Transaction can be posted at a time. For guidance on how to use this page, see the <a href="https://docs.orderful.com/docs/create-a-transaction#make-an-api-call-using-our-api-explorer" target="_blank">Create a Transaction guide</a>. Check the status field to determine if the transaction was successfully accepted for processing or failed.

post/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/transactions/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

orderful-api-versionstring

Specifies the API version to use.

Request body

The type of Transaction to be created. Please refer to our <a href="https://docs.orderful.com/reference/available-transaction-types" target="_blank">list of available Transaction Types</a>.

stream'test' | 'live' required

Name of stream to create the transaction on.

senderIdstring required

Sender identifier.

receiverIdstring required

Receiver identifier.

Response

Transaction processing. Check the status field to determine if the transaction was successfully accepted for processing or failed.

idstring required

Transaction id.

status'FAILED' | 'ACCEPTED' required

Status of the request.

detailstring required

Error detail message.

Example response

{
  "id": "000000"
}

Changes

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