The Get Transactions API retrieves a list of transactions with optional filtering, sorting, and pagination.
Your secret API key. Include it with every request.
Every query parameter below is optional. Combine as many as you need and append them to the endpoint as a query string. The example shows a few to get you started.
/v1/transactions?state_code=<state_code>&country=<country>&status=<status>Filter transactions by state code.
Filter by transaction type (e.g., SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, ARCHIVE etc.).
Filter transactions based on the source.
Search for transactions using a general query (e.g., order ID, customer name).
Filter transactions by country code (ISO 3166-1 alpha-2 format, e.g., US).
AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EUFilter by full state name (e.g., California).
Filter by address status (e.g., UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE).
Filter by transaction status (e.g., PENDING, COMMITTED, CANCELLED, ARCHIVED). For refund filtering use the refund_status parameter.
PENDINGCOMMITTEDCANCELLEDFULLY_REFUNDEDPARTIALLY_REFUNDEDINVALIDARCHIVEDFilter by refund status (e.g., FULLY_REFUNDED, PARTIALLY_REFUNDED).
FULLY_REFUNDEDPARTIALLY_REFUNDEDRetrieve transactions linked to a specific filing ID.
Sort results based on specified fields. Prefix with - for descending order (e.g., -date for newest first).
Retrieve transactions with a date greater than or equal to the bound (YYYY-MM-DD or ISO datetime in UTC). Defaults to 12 months ago when neither date__gte nor date__lte is provided.
Retrieve transactions with a date less than or equal to the bound (YYYY-MM-DD or ISO datetime in UTC).
Filter transactions based on processing status. Multiple values can be passed as a comma-separated list.
Filter transactions by marketplace (e.g., AMAZON, EBAY).
Filter transactions by exemption status. Multiple values can be passed as a comma-separated list (e.g., EXEMPT,TAXABLE).
Filter transactions by connection ID (comma-separated)
conn_abc123conn_def456Filter by transaction direction (SALE or PURCHASE). When unset, the list includes both directions.
SALEPURCHASEOptional upper bound for the pagination COUNT query.
When set, the returned total is capped at this value and pages
is derived from the capped total, making large result sets faster
to paginate at the cost of approximate totals. When unset, total
and pages reflect the exact count (existing behavior).
Page number
Page size
Successfully retrieved transactions
Unauthenticated request.
Resource not found
Validation error
Internal server error