v1

latestOpenAPI 3.0.02026-07-2421110121.4 KB

Transaction (v3)

List Transactions

Returns an array of Transactions sorted in descending order by their creation date. A maximum of 100 Transactions will be returned at a time.

get/v3/transactions

Query parameters

prevCursorstring

If results are <a href="https://docs.orderful.com/reference/pagination" target="_blank">paginated</a>, this will point to the previous set of results.

nextCursorstring

If results are <a href="https://docs.orderful.com/reference/pagination" target="_blank">paginated</a>, this will point to the next set of results.

createdAtstring

The date and time that the Transactions were created on or before, in ISO-8601 format. This is used to <a href="https://docs.orderful.com/reference/filtering" target="_blank">filter results</a>.

streamstring[]

Indicates whether you want results from the Test and/or Live stream.

businessNumberstring[]

Indicates which business number(s) you would like to list Transactions from. You may indicate up to 5 business numbers.

transactionTypestring[]

Indicates the Transaction Type(s) you would like to filter by. You may indicate up to 5 <a href="https://docs.orderful.com/reference/available-transaction-types" target="_blank">Transaction Types</a>.

validationStatusstring[]

The one or more validation status(es) you would like to filter by.

deliveryStatusstring[]

The one or more delivery status(es) you would like to filter by.

acknowledgmentStatusstring[]

The one or more acknowledgment status(es) you would like to filter by.

senderIsaIdstring[]

The Sender ISA ID(s) that you would like to list Transactions from. You may indicate up to 5 Sender ISA IDs.

receiverIsaIdstring[]

The Receiver ISA ID(s) that you would like to list Transactions from. You may indicate up to 5 Receiver ISA IDs.

referenceIdentifierstring

Reference Identifier Value you would like to filter by.

senderInterchangeReferenceIdentifierstring

Sender's Interchange Reference Identifier Value you would like to filter by.

senderGroupReferenceIdentifierstring

Sender's (Functional) Group Reference Identifier Value you would like to filter by.

senderTransactionReferenceIdentifierstring

Sender's Transaction Reference Identifier Value you would like to filter by.

receiverInterchangeReferenceIdentifierstring

Receiver's Interchange Reference Identifier Value you would like to filter by.

receiverGroupReferenceIdentifierstring

Receiver's (Functional) Group Reference Identifier Value you would like to filter by.

receiverTransactionReferenceIdentifierstring

Receiver's Transaction Reference Identifier Value you would like to filter by.

Headers

orderful-api-keystring required

Your Orderful API key.

Response

List of transactions.

Example response

{
  "data": [
    {
      "id": "000000",
      "href": "https://api.orderful.com/v3/transactions/000000",
      "version": "v3",
      "stream": "TEST",
      "businessNumber": "BUSINESS_NUMBER",
      "referenceIdentifiers": [
        {
          "value": "000000001",
          "type": "INTERCHANGE",
          "owner": "SENDER"
        },
        {
          "value": "1",
          "type": "GROUP",
          "owner": "SENDER"
        },
        {
          "value": "0001",
          "type": "TRANSACTION",
          "owner": "SENDER"
        }
      ],
      "message": {
        "href": "https://api.orderful.com/v3/transactions/000000/message"
      },
      "validationStatus": "VALID",
      "deliveryStatus": "DELIVERED",
      "acknowledgmentStatus": "ACCEPTED",
      "createdAt": "2025-12-24T14:01:23.613Z",
      "lastUpdatedAt": "2025-12-24T14:01:23.613Z",
      "acknowledgment": {
        "href": "https://api.orderful.com/v3/transactions/000000/acknowledgment"
      }
    }
  ]
}