POST /exports/transactions

This API triggers export of transaction data. The exported zip file contains CSV files with transaction-related data.

Servers

Request headers

Name Type Required Description
chargebee-request-origin-device String No

The device from which the customer has made the request

Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

chargebee-event-webhook String No

skip only webhooks

Possible values:

  • "all-disabled"
chargebee-business-entity-id String No

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.

chargebee-event-actions String No

skip all actions to be done on the events

Possible values:

  • "all-disabled"
chargebee-request-origin-user String No

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

chargebee-request-origin-ip String No

The IP address of the customer where the request originated

chargebee-request-origin-user-encoded String No

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-event-email String No

skip only emails

Possible values:

  • "all-disabled"

Request body fields

Name Type Required Description
transaction Object No

Parameters for transaction

transaction.reference_number Object No

The reference number for this transaction. For example, the check number when [payment_method](transactions#transaction_payment_method) = `check`.

transaction.reference_number.starts_with String No
transaction.reference_number.is_not String No
transaction.reference_number.is String No
transaction.reference_number.is_present String No

Possible values:

  • "false"
  • "true"
transaction.gateway Object No

Gateway through which this transaction was done. Applicable only for 'Card' Payment Method

transaction.gateway.not_in String No
transaction.gateway.in String No
transaction.gateway.is_not String No

* `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. * `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 is a payment gateway that enables you to securely accept and manage digital payments across different payment_source_type. * `not_applicable` - Indicates that payment gateway is not applicable for this resource.

Possible values:

  • "first_data_global"
  • "cybersource"
  • "wepay"
  • "paymill"
  • "quickbooks"
  • "moneris_us"
  • "checkout_com"
  • "ingenico_direct"
  • "migs"
  • "worldpay"
  • "exact"
  • "bluesnap"
  • "adyen"
  • "orbital"
  • "global_payments"
  • "pay_com"
  • "bluepay"
  • "amazon_payments"
  • "paypal_payflow_pro"
  • "wirecard"
  • "paypal"
  • "ogone"
  • "stripe"
  • "not_applicable"
  • "paypal_express_checkout"
  • "beanstream"
  • "paypal_pro"
  • "braintree"
  • "elavon"
  • "vantiv"
  • "ecentric"
  • "jp_morgan"
  • "mollie"
  • "balanced_payments"
  • "nuvei"
  • "paystack"
  • "moneris"
  • "gocardless"
  • "hdfc"
  • "razorpay"
  • "chargebee_payments"
  • "windcave"
  • "ebanx"
  • "bank_of_america"
  • "chargebee"
  • "pin"
  • "eway"
  • "nmi"
  • "eway_rapid"
  • "sage_pay"
  • "tco"
  • "dlocal"
  • "authorize_net"
  • "metrics_global"
transaction.gateway.is String No

* `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. * `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 is a payment gateway that enables you to securely accept and manage digital payments across different payment_source_type. * `not_applicable` - Indicates that payment gateway is not applicable for this resource.

Possible values:

  • "first_data_global"
  • "cybersource"
  • "wepay"
  • "paymill"
  • "quickbooks"
  • "moneris_us"
  • "checkout_com"
  • "ingenico_direct"
  • "migs"
  • "worldpay"
  • "exact"
  • "bluesnap"
  • "adyen"
  • "orbital"
  • "global_payments"
  • "pay_com"
  • "bluepay"
  • "amazon_payments"
  • "paypal_payflow_pro"
  • "wirecard"
  • "paypal"
  • "ogone"
  • "stripe"
  • "not_applicable"
  • "paypal_express_checkout"
  • "beanstream"
  • "paypal_pro"
  • "braintree"
  • "elavon"
  • "vantiv"
  • "ecentric"
  • "jp_morgan"
  • "mollie"
  • "balanced_payments"
  • "nuvei"
  • "paystack"
  • "moneris"
  • "gocardless"
  • "hdfc"
  • "razorpay"
  • "chargebee_payments"
  • "windcave"
  • "ebanx"
  • "bank_of_america"
  • "chargebee"
  • "pin"
  • "eway"
  • "nmi"
  • "eway_rapid"
  • "sage_pay"
  • "tco"
  • "dlocal"
  • "authorize_net"
  • "metrics_global"
transaction.status Object No

The status of this transaction.

transaction.status.not_in String No
transaction.status.in String No
transaction.status.is_not String No

* `in_progress` - Transaction is being processed by the gateway. This typically happens for direct debit transactions 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.

Possible values:

  • "in_progress"
  • "timeout"
  • "success"
  • "voided"
  • "failure"
  • "late_failure"
  • "needs_attention"
transaction.status.is String No

* `in_progress` - Transaction is being processed by the gateway. This typically happens for direct debit transactions 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.

Possible values:

  • "in_progress"
  • "timeout"
  • "success"
  • "voided"
  • "failure"
  • "late_failure"
  • "needs_attention"
transaction.payment_method Object No

The payment method of this transaction

transaction.payment_method.not_in String No
transaction.payment_method.in String No
transaction.payment_method.is_not String No

* `card` - Card * `cash` - Cash * `check` - Check * `chargeback` - Only applicable for a transaction of type = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a refund. * `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

Possible values:

  • "upi"
  • "online_banking_poland"
  • "unionpay"
  • "cash"
  • "direct_debit"
  • "boleto"
  • "netbanking_emandates"
  • "giropay"
  • "custom"
  • "check"
  • "venmo"
  • "payconiq_by_bancontact"
  • "card"
  • "klarna_pay_now"
  • "faster_payments"
  • "sepa_instant_transfer"
  • "alipay"
  • "bancontact"
  • "amazon_payments"
  • "chargeback"
  • "other"
  • "sofort"
  • "automated_bank_transfer"
  • "bank_transfer"
  • "paypal_express_checkout"
  • "apple_pay"
  • "pay_to"
  • "sepa_credit"
  • "dotpay"
  • "ach_credit"
  • "google_pay"
  • "wechat_pay"
  • "ideal"
transaction.payment_method.is String No

* `card` - Card * `cash` - Cash * `check` - Check * `chargeback` - Only applicable for a transaction of type = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a refund. * `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

Possible values:

  • "upi"
  • "online_banking_poland"
  • "unionpay"
  • "cash"
  • "direct_debit"
  • "boleto"
  • "netbanking_emandates"
  • "giropay"
  • "custom"
  • "check"
  • "venmo"
  • "payconiq_by_bancontact"
  • "card"
  • "klarna_pay_now"
  • "faster_payments"
  • "sepa_instant_transfer"
  • "alipay"
  • "bancontact"
  • "amazon_payments"
  • "chargeback"
  • "other"
  • "sofort"
  • "automated_bank_transfer"
  • "bank_transfer"
  • "paypal_express_checkout"
  • "apple_pay"
  • "pay_to"
  • "sepa_credit"
  • "dotpay"
  • "ach_credit"
  • "google_pay"
  • "wechat_pay"
  • "ideal"
transaction.date Object No

Indicates when this transaction occurred.

transaction.date.on String No
transaction.date.after String No
transaction.date.between String No
transaction.date.before String No
transaction.updated_at Object No

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.

transaction.updated_at.on String No
transaction.updated_at.after String No
transaction.updated_at.between String No
transaction.updated_at.before String No
transaction.id Object No

Uniquely identifies the transaction.

transaction.id.not_in String No
transaction.id.starts_with String No
transaction.id.in String No
transaction.id.is_not String No
transaction.id.is String No
transaction.customer_id Object No

Identifier of the customer for which this transaction is made

transaction.customer_id.not_in String No
transaction.customer_id.starts_with String No
transaction.customer_id.in String No
transaction.customer_id.is_not String No
transaction.customer_id.is String No
transaction.customer_id.is_present String No

Possible values:

  • "false"
  • "true"
transaction.id_at_gateway Object No

The id with which this transaction is referred in gateway.

transaction.id_at_gateway.starts_with String No
transaction.id_at_gateway.is_not String No
transaction.id_at_gateway.is String No
transaction.gateway_account_id Object No

The gateway account used for this transaction

transaction.gateway_account_id.not_in String No
transaction.gateway_account_id.starts_with String No
transaction.gateway_account_id.in String No
transaction.gateway_account_id.is_not String No
transaction.gateway_account_id.is String No
transaction.amount Object No

Amount for this transaction.

transaction.amount.gt String No
transaction.amount.lte String No
transaction.amount.between String No
transaction.amount.gte String No
transaction.amount.is_not String No
transaction.amount.lt String No
transaction.amount.is String No
transaction.type Object No

Type of the transaction.

transaction.type.not_in String No
transaction.type.in String No
transaction.type.is_not String No

* `authorization` - The transaction represents an authorization for capturing the amount from the customer's payment_source. * `payment` - The transaction represents capture of amount from the customer's payment_source. * `refund` - The transaction represents a refund of amount to the customer's payment_source. * `payment_reversal` - Indicates a reversal transaction.

Possible values:

  • "payment_reversal"
  • "refund"
  • "authorization"
  • "payment"
transaction.type.is String No

* `authorization` - The transaction represents an authorization for capturing the amount from the customer's payment_source. * `payment` - The transaction represents capture of amount from the customer's payment_source. * `refund` - The transaction represents a refund of amount to the customer's payment_source. * `payment_reversal` - Indicates a reversal transaction.

Possible values:

  • "payment_reversal"
  • "refund"
  • "authorization"
  • "payment"
transaction.payment_source_id Object No

To filter based on Transaction payment source id.

transaction.payment_source_id.not_in String No
transaction.payment_source_id.starts_with String No
transaction.payment_source_id.in String No
transaction.payment_source_id.is_not String No
transaction.payment_source_id.is String No
transaction.payment_source_id.is_present String No

Possible values:

  • "false"
  • "true"
transaction.amount_capturable Object No

To filter based on transaction's unused authorized/blocked amount.

transaction.amount_capturable.gt String No
transaction.amount_capturable.lte String No
transaction.amount_capturable.between String No
transaction.amount_capturable.gte String No
transaction.amount_capturable.is_not String No
transaction.amount_capturable.lt String No
transaction.amount_capturable.is String No
transaction.subscription_id Object No

Identifier of the subscription for which this transaction is made.

transaction.subscription_id.not_in String No
transaction.subscription_id.starts_with String No
transaction.subscription_id.in String No
transaction.subscription_id.is_not String No
transaction.subscription_id.is String No
transaction.subscription_id.is_present String No

Possible values:

  • "false"
  • "true"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.