List Transactions

List transactions

GET/transactions

Use it in a workflow

Add a step and choose the Chargebee connector.
Pick the List Transactions action (under Chargebee API).
Fill in the fields below, then reference the result from later steps as {{listTransactions.response.data}}.

Request

Query parameters

limitinteger (int32)

The number of resources to be returned.

Default 10

offsetstring

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code> to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code> obtained in the previous iteration of the API call.

include_deletedboolean

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 false

idobject

optional, string filter Uniquely identifies the transaction. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *id\[is\] = "txn_88ybdbsnvf2"*

isstring

is_notstring

starts_withstring

instring

not_instring

customer_idobject

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"*

isstring

is_notstring

starts_withstring

is_presentstring (boolean)

One oftruefalse

instring

not_instring

subscription_idobject

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"*

isstring

is_notstring

starts_withstring

is_presentstring (boolean)

One oftruefalse

instring

not_instring

payment_source_idobject

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"*

isstring

is_notstring

starts_withstring

is_presentstring (boolean)

One oftruefalse

instring

not_instring

payment_methodobject

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"*

isstring

* `card` - Card * `cash` - Cash * `check` - Check * `chargeback` - Only applicable for a transaction of <code><a href="transactions#transaction_type">type</a></code> = <code>refund</code>. This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" rel="noopener noreferrer" target="_blank">chargeback</a> occurs. You can also set this explicitly when <a href="transactions#record_an_offline_refund">recording a refund</a>. * `bank_transfer` - Bank Transfer * `amazon_payments` - Amazon Payments * `paypal_express_checkout` - Paypal Express Checkout * `direct_debit` - Direct Debit * `alipay` - Alipay * `unionpay` - Unionpay * `apple_pay` - Apple Pay * `wechat_pay` - WeChat Pay * `ach_credit` - ACH Credit * `sepa_credit` - SEPA Credit * `ideal` - IDEAL * `google_pay` - Google Pay * `sofort` - Sofort * `bancontact` - Bancontact * `giropay` - giropay * `dotpay` - Dotpay * `other` - Payment Methods other than the above types * `app_store` - **(Deprecated)** App Store * `upi` - upi * `netbanking_emandates` - netbanking_emandates * `play_store` - **(Deprecated)** Play Store * `custom` - Custom * `boleto` - boleto * `venmo` - Venmo * `pay_to` - PayTo * `faster_payments` - Faster Payments * `sepa_instant_transfer` - Sepa Instant Transfer * `automated_bank_transfer` - Automated Bank Transfer * `klarna_pay_now` - Klarna Pay Now * `online_banking_poland` - Online Banking Poland * `payconiq_by_bancontact` - Payconiq by Bancontact * `electronic_payment_standard` - Payments made via Electronic Payment Standard. * `kbc_payment_button` - Payments made via KBC Payment Button. * `pay_by_bank` - Payments made via Pay By Bank. * `trustly` - Payments made via Trustly. * `stablecoin` - Stablecoin * `kakao_pay` - Kakao Pay * `naver_pay` - Naver Pay * `revolut_pay` - Revolut Pay * `cash_app_pay` - Cash App Pay * `pix` - Payments made via Pix * `twint` - Twint * `go_pay` - Go Pay * `grab_pay` - Grab Pay * `pay_co` - Pay Co * `after_pay` - After Pay * `swish` - Swish * `payme` - PayMe * `klarna` - Payments made via Klarna * `alipay_hk` - Alipay HK * `paypay` - PayPay * `gcash` - GCash * `south_korean_cards` - Payments made via South Korean Cards * `paynow` - Payments made via PayNow * `bizum` - Payments made via Bizum * `promptpay` - Payments made via PromptPay

One ofcardcashcheckchargebackbank_transferamazon_paymentspaypal_express_checkoutdirect_debitalipayunionpayapple_paywechat_payach_creditsepa_creditidealgoogle_paysofortbancontactgiropaydotpayotherupinetbanking_emandatescustomboletovenmopay_tofaster_paymentssepa_instant_transferautomated_bank_transferklarna_pay_nowonline_banking_polandpayconiq_by_bancontactelectronic_payment_standardkbc_payment_buttonpay_by_banktrustlystablecoinkakao_paynaver_pay

is_notstring

instring

not_instring

gatewayobject

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"*

isstring

* `chargebee` - Chargebee test gateway. * `chargebee_payments` - Chargebee Payments gateway * `adyen` - Adyen is a payment gateway. * `stripe` - Stripe is a payment gateway. * `wepay` - WePay is a payment gateway. * `braintree` - Braintree is a payment gateway. * `authorize_net` - Authorize.net is a payment gateway * `paypal_pro` - PayPal Pro Account is a payment gateway. * `pin` - Pin is a payment gateway * `eway` - eWAY Account is a payment gateway. * `eway_rapid` - eWAY Rapid is a payment gateway. * `worldpay` - WorldPay is a payment gateway * `balanced_payments` - Balanced is a payment gateway * `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway. * `bluepay` - BluePay is a payment gateway. * `elavon` - Elavon Virtual Merchant is a payment solution. * `first_data_global` - First Data Global Gateway Virtual Terminal Account * `hdfc` - HDFC Account is a payment gateway. * `migs` - MasterCard Internet Gateway Service payment gateway. * `nmi` - NMI is a payment gateway. * `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway. * `paymill` - PAYMILL is a payment gateway. * `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway. * `sage_pay` - Sage Pay is a payment gateway. * `tco` - 2Checkout is a payment gateway. * `wirecard` - WireCard Account is a payment service provider. * `amazon_payments` - Amazon Payments is a payment service provider. * `paypal_express_checkout` - PayPal Express Checkout is a payment gateway. * `gocardless` - GoCardless is a payment service provider. * `orbital` - Chase Paymentech(Orbital) is a payment gateway. * `moneris_us` - Moneris USA is a payment gateway. * `moneris` - Moneris is a payment gateway. * `bluesnap` - BlueSnap is a payment gateway. * `cybersource` - CyberSource is a payment gateway. * `vantiv` - Vantiv is a payment gateway. * `checkout_com` - Checkout.com is a payment gateway. * `paypal` - PayPal Commerce is a payment gateway. * `ingenico_direct` - Worldline Online Payments is a payment gateway. * `exact` - Exact Payments is a payment gateway. * `mollie` - Mollie is a payment gateway. * `quickbooks` - Intuit QuickBooks Payments gateway * `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. * `global_payments` - Global Payments is a payment service provider. * `bank_of_america` - Bank of America Gateway * `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. * `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US. * `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. * `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes. * `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion. * `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods. * `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. * `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. * `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. * `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different <a http='payment_sources?lang=curl#payment_source_type'><code>payment_source_type</code></a>. * `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. * `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.<div class='alert alert-info'> Ezidebit is in beta.</div> * `twikey` - Twikey is a payment gateway that provides automated payment collection and mandate management solutions. * `tempus` - Tempus Technologies is a payment gateway and payments technology provider offering secure payment processing with end-to-end encryption (P2PE) and tokenization. * `moyasar` - Moyasar is a fully integrated online payment services that makes accepting payments simple and secure * `payway` - Payway is a payment gateway that enables secure card and payment acceptance. * `not_applicable` - Indicates that payment gateway is not applicable for this resource.

One ofchargebeechargebee_paymentsadyenstripewepaybraintreeauthorize_netpaypal_propinewayeway_rapidworldpaybalanced_paymentsbeanstreambluepayelavonfirst_data_globalhdfcmigsnmiogonepaymillpaypal_payflow_prosage_paytcowirecardamazon_paymentspaypal_express_checkoutgocardlessorbitalmoneris_usmonerisbluesnapcybersourcevantivcheckout_compaypalingenico_directexactmollie

is_notstring

instring

not_instring

gateway_account_idobject

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"*

isstring

is_notstring

starts_withstring

instring

not_instring

id_at_gatewayobject

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"*

isstring

is_notstring

starts_withstring

reference_numberobject

<dfn class="text-muted">optional, string filter</dfn> The reference number for this transaction. For example, the check number when <code><a href="/docs/api/transactions/transaction-object#payment_method">payment_method</a></code> = <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">check</code> . Supported operators : is, is_not, starts_with, is_present Example → reference_number[is] = "cus_u239732"

isstring

is_notstring

starts_withstring

is_presentstring (boolean)

One oftruefalse

typeobject

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"*

isstring

* `authorization` - The transaction represents an authorization for capturing the <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>. * `payment` - The transaction represents capture of <code><a href="transactions#transaction_amount">amount</a></code> from the customer’s <code><a href="payment_sources">payment_source</a></code>. * `refund` - The transaction represents a refund of <code><a href="transactions#transaction_amount">amount</a></code> to the customer’s <code><a href="payment_sources">payment_source</a></code>. * `payment_reversal` - Indicates a reversal transaction.

One ofauthorizationpaymentrefundpayment_reversal

is_notstring

One ofauthorizationpaymentrefundpayment_reversal

instring

One ofauthorizationpaymentrefundpayment_reversal

not_instring

One ofauthorizationpaymentrefundpayment_reversal

dateobject

<dfn class="text-muted">optional, timestamp(UTC) in seconds filter</dfn> Indicates when this transaction occurred. We recommend using this filter when listing transactions for better query performance. It is advisable when using this filter, to pass the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code> input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">date</code> for a faster response. Supported operators : after, before, on, between Example → date[before] = "1435054328"

afterstring (unix-time)

beforestring (unix-time)

onstring (unix-time)

betweenstring

amountobject

optional, in cents filter Amount for this transaction. **Supported operators :** is, is_not, lt, lte, gt, gte, between **Example →** *amount\[gt\] = "1200"*

isstring (number)

is_notstring (number)

ltstring (number)

ltestring (number)

gtstring (number)

gtestring (number)

betweenstring

amount_capturableobject

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"*

isstring (number)

is_notstring (number)

ltstring (number)

ltestring (number)

gtstring (number)

gtestring (number)

betweenstring

statusobject

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"*

isstring

\* \`in_progress\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* \`success\` - The transaction is successful. \* \`voided\` - The transaction got voided or authorization expired at gateway. \* \`failure\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \* \`timeout\` - Transaction failed because of Gateway not accepting the connection. \* \`needs_attention\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* \`late_failure\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.

One ofin_progresssuccessvoidedfailuretimeoutneeds_attentionlate_failure

is_notstring

One ofin_progresssuccessvoidedfailuretimeoutneeds_attentionlate_failure

instring

One ofin_progresssuccessvoidedfailuretimeoutneeds_attentionlate_failure

not_instring

One ofin_progresssuccessvoidedfailuretimeoutneeds_attentionlate_failure

updated_atobject

<dfn class="text-muted">optional, timestamp(UTC) in seconds filter</dfn> To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>. 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 <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code> input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code> for a faster response. Supported operators : after, before, on, between Example → updated_at[after] = "1243545465"

afterstring (unix-time)

beforestring (unix-time)

onstring (unix-time)

betweenstring

sort_byobject

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.

ascstring

One ofdateupdated_at

descstring

One ofdateupdated_at

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

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

chargebee-request-origin-user-encodedstring (email)

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.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-business-entity-idstring

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.

Response

Returns 200 with an object. Read it in later steps with {{listTransactions.response.data.<field>}}.

listarray<object>

transactionobjectrequired40 fields

This resource represents the [transaction](https://www.chargebee.com/docs/transactions.html) event that has happened in your account.

next_offsetstring

This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>.

json

{
  "list": null,
  "next_offset": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.

Was this page helpful?