List Transactions
Fetch a list of transactions, sorted by the date they were created from newest to oldest.
/transactions
This endpoint fetches a list of all the transactions Stedi has processed in your account. It's useful for displaying a list of transactions in a UI. If you want to programmatically fetch and check for new transactions, you should use the Poll Transactions endpoint instead.
A Stedi API Key for authentication.
Query Parameters
The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.
- Range:
≥ 1 and ≤ 500
A token returned by a previous call to this operation in the nextPageToken
. If not specified, Stedi returns the first page of results.
- Required string length:
1 - 1024
List only transactions containing a business identifier with the given value.
Any valid 3-digit X12 Transaction Set Identifier Code, as defined in the X12 standard. See: https://www.stedi.com/edi/x12/element/143.
100
101
102
103
104
List only transactions sent by the given profile. This is the profile ID of the sender.
List only transactions sent to the given profile. This is the profile ID of the receiver.
The direction of the transaction. Inbound transactions are those you receive from a payer, provider, or other trading partner. Outbound transactions are those you send to a payer, provider, or other trading partner.
INBOUND
OUTBOUND
UNKNOWN
Indicates whether the transaction contains test or production data. Stedi determines this from the value in ISA15
Usage Indicator Code.
test
production
other
A status indicating whether Stedi was able to successfully process the transaction.
failed
succeeded
- Format:
date-time
- Format:
date-time
List only transactions containing a business identifier with the given element ID. This is the X12 element ID, such as "127" for Reference Identification. May only be supplied if businessIdentifier
is also supplied. See Stedi's EDI references pages to find element IDs.
List only transactions that were sent or received on the given partnership. This is the partnership ID, such as "local_clearinghouse-test".
Response
ListTransactions 200 response
Token for pagination to retrieve the next page of results; null if there are no more results
- Required string length:
1 - 1024
The processed transactions that match the request criteria. The items
array is empty if there are no matching transactions.
curl --request GET \
--url "https://core.us.stedi.com/2023-08-01/transactions?pageSize=200" \
--header "Authorization: <api_key>"
fetch("https://core.us.stedi.com/2023-08-01/transactions?pageSize=200", {
headers: {
"Authorization": "<api_key>"
}
})
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://core.us.stedi.com/2023-08-01/transactions?pageSize=200"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api_key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
import requests
url = "https://core.us.stedi.com/2023-08-01/transactions?pageSize=200"
response = requests.request("GET", url, headers = {
"Authorization": "<api_key>"
})
print(response.text)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.build();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("https://core.us.stedi.com/2023-08-01/transactions?pageSize=200"))
.header("Authorization", "<api_key>")
.GET()
.build();
try {
HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
System.out.println("Status code: " + response.statusCode());
System.out.println("Response body: " + response.body());
} catch (Exception e) {
e.printStackTrace();
}
{
"message": "string"
}
{
"message": "string",
"code": "string"
}
{
"message": "string",
"code": "string"
}
{
"message": "string",
"code": "string"
}
{
"message": "string",
"code": "string"
}
{
"message": "string",
"cause": {
"name": "string",
"message": "string",
"stack": "string"
}
}
{
"message": "string",
"code": "string"
}
{
"message": "string",
"code": "string"
}