Transactions API
The Transaction API is part of the core
service and thus all requests should go to https://api.subsbase.io/core/graphql
.
The core service expects 2 headers, the X-SITE-ID
and authorization
so the request would be:
POST https://api.subsbase.io/core/graphql
Authorization: Bearer {server token}
X-SITE-ID: {your site id}
Consuming the Transaction API requires that a server token is used to authenticate the request. The server token is expected in the
Authorization
header
Queries
Transactions Query
query GetTransactions($siteId: String!, $pagination: PaginationGQLInputType, $sorting: [SortingGQLInputType], $filter: [FilterGQLInputType]){
transactions(siteId: $siteId, pagination: $pagination, sorting: $sorting, filter: $filter) {
isSuccess
message
pagination {
page
perPage
totalRecords
}
data {
id
status
customer {
id
}
// all transaction fields are available...
}
}
}
- Request Variables Sample:
const variables = {
siteId: "Your site ID",
pagination: {
page: 1,
perPage: 10,
},
sorting: [
{
field: "id",
direction: "Descending",
},
],
filter: [
{
field: "id",
operator: "Contains",
value: "255",
},
],
};
- Returns an array of transactions
- You can specify any of the fields detailed in the Transaction Type Definition
- For details about Pagination, Sorting and Filtering Input Types check out PaginationGQLInputType, SortingGQLInputType, FilteringGQLInputType
Transaction Query
query GetTransaction($siteId: String!, $transactionId: String!) {
transaction(siteId: $siteId, transactionId: $transactionId) {
id
status
customer {
id
}
// all transaction fields are available...
}
}
- Returns the specific transaction
- You can specify any of the fields detailed in the Transaction Type Definition
Table of Contents