List payment transactions with filtering, sorting, and pagination
Lists payment transactions, newest first unless sorted_by says otherwise. A company admin sees only the current company’s transactions, whatever company_id is sent. A platform administrator sees every company, can filter with company_id, and also receives am_authorization on each row. Pagination is cursor-based: send page[limit] (1-100, default 20) and pass meta.pagination.next_cursor back as page[cursor]. Requires a Bearer token with the transactions.view permission.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Pagination parameters
A sortable column with an _asc or _desc suffix. Sortable columns are id, created_at, action, status, amount, currency_code, country_code, transaction_id, slug, cart_id, company_name, company_id, customer_name, customer_id, payment_account, integration_class, order_source, type, latency, processing_fee, platform_fee and response_message. An unrecognised value falls back to created_at_desc rather than erroring. Comma-separate to sort on more than one column.
Filter by order ID or order token
Filter by cart ID or cart token
Filter by transaction ID
Filter by payment action
show, update, create_payment_source, create_payment_token, create_customer_token, create_paypal_order, retain, verify, authorize, capture, purchase, cancel, refund, void, settle, charge, agreement Filter by payment status
unsent, sent, received, success, declined, pending, error, expired Filter by company ID
Filter by integration class
Affirm, AfterpayPpro, AliPayCitcon, AliPayHkCitcon, BancontactPpro, BankTransferCitcon, BlikPpro, Bread, CashAppCitcon, CreditCard, Droplet, EpsPpro, GCashCitcon, GrabPayCitcon, IdealPpro, JkoPayCitcon, KakaoPayCitcon, Klarna, KlarnaCitcon, LinePayCitcon, LinePayDlocal, MayaCitcon, MercadoPagoDlocal, OxxoCitcon, OxxoDlocal, P24Ppro, PayPayCitcon, Paypal, PixCitcon, RakutenPayCitcon, SatispayPpro, SkrillPpro, TrustlyPpro, UPIIndiaCitcon, UnionPayCitcon, WechatPayCitcon, YapeDlocal Filter by gateway name
ActiveMerchant::Billing::AdyenGateway, ActiveMerchant::Billing::Bogus, ActiveMerchant::Billing::BraintreeGateway, ActiveMerchant::Billing::CheckoutV2Gateway, ActiveMerchant::Billing::CyberSourceRestGateway, ActiveMerchant::Billing::NmiGateway, ActiveMerchant::Billing::PaypalRestGateway, ActiveMerchant::Billing::StripePaymentIntentsGateway, ActiveMerchant::Billing::WorldpayGateway Filter by currency code
Filter by the payment's billing country, as an ISO 3166-1 alpha-2 code. Accepted values are listed by the filter_options operation.
Filter by customer ID
Filter by order source
Filter by payment type (test/live)
test, live