List transactions

Returns a list of all transactions under the account.

By default, GET /transactions returns transactions ordered by the latest createdAt. You can combine the different filters as documented.

This endpoint supports cursor-based pagination.

Add expand to embed each transaction's related resources under _embedded in the same response, for example expand=cardSubscription,card,cardholder. Each embedded resource is the exact body its own endpoint serves, shows its current values (not those at the time of the transaction) except cardholder.corporate, which is resolved as of the transaction's date (see the expand parameter), and requires that endpoint's scope: card-subscriptions:read for cardSubscription, cards:read for card, cardholder:read for cardholder. Transactions without a given related resource simply omit that key. Pagination links preserve expand.

For the company and legal entity a card belonged to when the transaction happened, use expand=cardholder and read cardholder.corporate.id and cardholder.corporate.legalEntity. They are the values in effect on the transaction's transactionOccurrenceDate (through the end of that UTC day), or at the transaction's createdAt when that is null, so a card that later moved to another company or legal entity keeps its historical attribution on past transactions. Transactions themselves do not carry a company identifier.

To list the transactions of one company or legal entity, filter with companyId, legalEntityId or legalEntityName. They match the cardholder's corporate.id, corporate.legalEntity.id and corporate.legalEntity.name on the transaction date: the values expand=cardholder returns on each transaction, not the cardholder's current ones (see the Glossary). Each is an exact, case-sensitive match, so copy the value from a transaction's expand=cardholder. The filters use the same as-of resolution as expand=cardholder, including the earliest recorded values for a transaction dated before Astrada started recording the card's corporate history. A transaction whose card has no cardholder data, or whose card GET /cards/{cardId} no longer returns, does not match, just as expand embeds no cardholder for it. They combine with each other and with transactionMessageId, cardId, subaccountId and networkBulkFeedId: supplying more than one returns only the transactions matching all of them. Transactions without a card never match. For example, this returns one legal entity's transactions on one feed:

GET /transactions?networkBulkFeedId=<feed>&legalEntityId=<id>

URL-encode the values. In legalEntityName a space is %20 (or +), and a literal + is read as a space, so send a + in the name as %2B. Send each filter once. Leading and trailing spaces are ignored. A value that is empty or only spaces, or longer than 255 characters, is refused with 400.

With any of these filters a page can hold fewer than limit transactions, even none, while _links.next is present. Keep following _links.next until it is absent.

These three filters read cardholder data, so they need the cardholder:read scope, like expand=cardholder. Without it the request returns 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid
uuid
string

The cursor to use for pagination. Identifies your place on the list

uuid
uuid
string
length between 1 and 255

Only transactions whose card's cardholder had this company ID (corporate.id) on the transaction date (the value expand=cardholder returns on that transaction; the expand parameter defines the date), not the cardholder's current company. Exact, case-sensitive match. Requires the cardholder:read scope.

string
length between 1 and 255

Only transactions whose card's cardholder belonged to this legal entity (corporate.legalEntity.id) on the transaction date (the value expand=cardholder returns on that transaction; the expand parameter defines the date), not the legal entity it belongs to now. Exact, case-sensitive match. Requires the cardholder:read scope.

string
length between 1 and 255

Only transactions whose card's cardholder belonged to a legal entity with this name (corporate.legalEntity.name) on the transaction date (the value expand=cardholder returns on that transaction; the expand parameter defines the date), not the legal entity it belongs to now. Exact, case-sensitive match. URL-encode the value: a space is %20 (or +), for example legalEntityName=Astrada%20Life. A literal + is read as a space, so send a + in the name as %2B. Requires the cardholder:read scope.

integer
1 to 100
Defaults to 25

Maximum number of items to return

string
enum
Defaults to desc
Allowed:
expand
array of strings

Comma-separated list of related resources to embed on the transaction under _embedded, so one call returns the transaction together with its card subscription, card and cardholder instead of follow-up calls to GET /card-subscriptions?cardId=, GET /cards/{cardId} and GET /cards/{cardId}/cardholder.

  • cardSubscription embeds the card subscription exactly as GET /card-subscriptions/{subscriptionId} serves it (without its own _embedded) and requires the card-subscriptions:read scope.
  • card embeds the transaction's card exactly as GET /cards/{cardId} serves it (without its own _embedded) and requires the cards:read scope.
  • cardholder embeds the card's cardholder as GET /cards/{cardId}/cardholder serves it, with one difference: corporate is the cardholder's corporate as of the transaction (see below). Requires the cardholder:read scope.

Each value is checked separately: a request asking to expand a resource its credentials cannot read is refused with 403.

The embedded subscription is the card's subscription in the transaction's sub-account: the one from the transaction's network bulk feed when the transaction has a networkBulkFeedId, otherwise the card's current subscription, otherwise its most recent one.

cardSubscription and card show their current values, not the values they had when the transaction happened. So does the cardholder, except for cardholder.corporate: its id, employeeId, alternativeEmployeeId and legalEntity are the values in effect on the transaction's transactionOccurrenceDate (through the end of that UTC day), or at the transaction's createdAt when transactionOccurrenceDate is null. A card that moved to another company or legal entity after the transaction therefore still shows the one it belonged to at the time. firstName, lastName, email, postalCode, corporate.networkToken, createdAt and updatedAt are the cardholder's current values. Changes are dated by when Astrada received them from the card network or through the API. For a transaction dated before Astrada started recording the card's corporate history, the earliest recorded values are returned instead. Either way, a value that was not set in the values returned is null, or for legalEntity absent.

A key is present only when it was requested and the related resource exists, and it is never null. A transaction with no card (cardId is null, for example a bank-sourced transaction with no linked card) has no cardSubscription, card or cardholder. A card without cardholder data has no cardholder. A card that GET /cards/{cardId} no longer returns (it responds 404, for example because all of its card subscriptions were deleted) is not embedded: both card and cardholder are absent. _links are unchanged. Without expand, _embedded is absent. Whether cardholder is embedded is decided on the card and cardholder as they are now, not as of the transaction's date.

Send one comma-separated value (expand=cardSubscription,card,cardholder). A repeated expand key, an empty value or an unknown value is refused with 400.

expand
Allowed:
Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/problem+json