GET /transactions

The device from which the customer has made the request

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

optional, string filter

The reference number for this transaction. For example, the check number when payment_method = check . Supported operators : is, is_not, starts_with, is_present

Example → reference_number[is] = "cus_u239732"

optional, enumerated string filter

Gateway through which this transaction was done. Applicable only for 'Card' Payment Method. Possible values are : chargebee, chargebee_payments, stripe, wepay, braintree, authorize_net, paypal_pro, pin, eway, eway_rapid, worldpay, balanced_payments, beanstream, bluepay, elavon, first_data_global, hdfc, migs, nmi, ogone, paymill, paypal_payflow_pro, sage_pay, tco, wirecard, amazon_payments, paypal_express_checkout, gocardless, adyen, orbital, moneris_us, moneris, bluesnap, cybersource, vantiv, checkout_com, paypal, ingenico_direct, exact, mollie, quickbooks, razorpay, not_applicable.

Supported operators : is, is_not, in, not_in

Example → gateway[is] = "stripe"

optional, enumerated string filter

The status of this transaction. Possible values are : in_progress, success, voided, failure, timeout, needs_attention.

Supported operators : is, is_not, in, not_in

Example → status[is] = "success"

optional, enumerated string filter

The payment method of this transaction. Possible values are : card, cash, check, chargeback, bank_transfer, amazon_payments, paypal_express_checkout, direct_debit, alipay, unionpay, apple_pay, wechat_pay, ach_credit, sepa_credit, ideal, google_pay, sofort, bancontact, giropay, dotpay, other, upi, netbanking_emandates.

Supported operators : is, is_not, in, not_in

Example → payment_method[is_not] = "card"

optional, timestamp(UTC) in seconds filter

Indicates when this transaction occurred. Supported operators : after, before, on, between

Example → date[before] = "1435054328"

If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*deleted\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\* ' attribute will be '\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*true\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\* '.

Default value: false

optional, timestamp(UTC) in seconds filter

To filter based on updated_at. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by input parameter as updated_at for a faster response. Supported operators : after, before, on, between

Example → updated_at[after] = "1243545465"

optional, string filter

Uniquely identifies the transaction. Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "txn_88ybdbsnvf2"

optional, string filter

Identifier of the customer for which this transaction is made. Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → customer_id[is] = "5hjdk8nOpd"

optional, string filter

The id with which this transaction is referred in gateway. Supported operators : is, is_not, starts_with

Example → id_at_gateway[is_not] = "txn_5678HJS89900"

The number of resources to be returned.

Default value: 10

optional, string filter

The gateway account used for this transaction. Supported operators : is, is_not, starts_with, in, not_in

Example → gateway_account_id[is] = "gw_3Nl9BNeQ7438Ks1"

optional, in cents filter

Amount for this transaction. Supported operators : is, is_not, lt, lte, gt, gte, between

Example → amount[gt] = "1200"

optional, enumerated string filter

Type of the transaction. Possible values are : authorization, payment, refund, payment_reversal.

Supported operators : is, is_not, in, not_in

Example → type[is_not] = "payment"

optional, string filter

To filter based on Transaction payment source id. Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → payment_source_id[is] = "pm_3Nl8XXUQUXDVFa2"

optional, in cents filter

To filter based on transaction's unused authorized/blocked amount. Supported operators : is, is_not, lt, lte, gt, gte, between

Example → amount_capturable[lt] = "1200"

optional, string filter

Sorts based on the specified attribute. Supported attributes : date, updated_at

Supported sort-orders : asc, desc

Example → sort_by[asc] = "date"

This will sort the result based on the 'date' attribute in ascending(earliest first) order.

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

optional, string filter

Identifier of the subscription for which this transaction is made. Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → subscription_id[is] = "5hjdk8nOpd"