Skip to main content
GET
List payment transactions with filtering, sorting, and pagination

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
object

Pagination parameters

sorted_by
string

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.

order_id
integer

Filter by order ID or order token

cart_id
integer

Filter by cart ID or cart token

transaction_id
string

Filter by transaction ID

payment_action
enum<string>

Filter by payment action

Available options:
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
status
enum<string>

Filter by payment status

Available options:
unsent,
sent,
received,
success,
declined,
pending,
error,
expired
company_id
integer

Filter by company ID

integration
enum<string>

Filter by integration class

Available options:
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
gateway
enum<string>

Filter by gateway name

Available options:
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
currency
integer

Filter by currency code

country_code
string

Filter by the payment's billing country, as an ISO 3166-1 alpha-2 code. Accepted values are listed by the filter_options operation.

customer_id
string

Filter by customer ID

order_source
string

Filter by order source

type
enum<string>

Filter by payment type (test/live)

Available options:
test,
live

Response

Success

transactions
object[]
meta
object