Void An Authorization Transaction

The device from which the customer has made the request

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

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.

The IP address of the customer where the request originated

skip all actions to be done on the events

One ofall-disabled

skip only emails

One ofall-disabled

skip only webhooks

One ofall-disabled

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.

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

Uniquely identifies the transaction.

Identifier of the customer for which this transaction is made

Identifier of the subscription for which this transaction is made.

The gateway account used for this transaction

Identifier of the payment source for which this transaction is made

<p class="mb-2">The payment method of this transaction</p> * naver_pay - <p class="mb-2">Payments made via Naver Pay.</p> <span featureId="cb-naver-pay" isMicro="true"></span> * unionpay - <p class="mb-2">Unionpay</p> * paypay - * online_banking_poland - <p class="mb-2">Online Banking Poland</p> <span featureId="cb-online-banking-poland" isMicro="true"></span> * upi - <p class="mb-2">upi</p> * payconiq_by_bancontact - <p class="mb-2">Payments made via Payconiq by Bancontact.</p> <span featureId="cb-payconiq-by-bancontact" isMicro="true"></span> * kakao_pay - <p class="mb-2">Payments made via Kakao Pay.</p> <span featureId="cb-kakao-pay" isMicro="true"></span> * check - <p class="mb-2">Check</p> * payme - <p class="mb-2">Payments made via PayMe</p> <span featureId="cb-payme" isMicro="true"></span> * cash_app_pay - <p class="mb-2">Payments made via Cash App Pay.</p> <span featureId="cb-cash-app-pay" isMicro="true"></span> * custom - <p class="mb-2">Custom</p> * amazon_payments - <p class="mb-2">Amazon Payments</p> * boleto - <p class="mb-2">boleto</p> * klarna - <p class="mb-2">Payments made via Klarna.</p> <span featureId="cb-klarna" isMicro="true"></span> * direct_debit - <p class="mb-2">Direct Debit</p> * klarna_pay_now - <p class="mb-2">Klarna Pay Now</p> <span featureId="cb-klarna-pay-now" isMicro="true"></span> * sepa_instant_transfer - <p class="mb-2">Sepa Instant Transfer</p> <span featureId="cb-sepa-instant-transfer" isMicro="true"></span> * apple_pay - <p class="mb-2">Apple Pay</p> * wechat_pay - <p class="mb-2">Payments made via WeChat Pay.</p> <span featureId="cb-wechat-pay" isMicro="true"></span> * twint - <p class="mb-2">Payments made via Twint</p> <span featureId="cb-twint" isMicro="true"></span> * kbc_payment_button - <p class="mb-2">KBC Payment Button</p> * bancontact - <p class="mb-2">Bancontact</p> * faster_payments - <p class="mb-2">Faster Payments</p> <span featureId="cb-faster-payments" isMicro="true"></span> * go_pay - <p class="mb-2">Payments made via GoPay</p> <span featureId="cb-go-pay" isMicro="true"></span> * stablecoin - <p class="mb-2">Payments made via Stablecoin.</p> <span featureId="cb-stablecoin" isMicro="true"></span> * venmo - <p class="mb-2">Venmo</p> <span featureId="cb-venmo" isMicro="true"></span> * bank_transfer - <p class="mb-2">Bank Transfer</p> * paypal_express_checkout - <p class="mb-2">Paypal Express Checkout</p> * electronic_payment_standard - <p class="mb-2">Electronic Payment Standard</p> * other - <p class="mb-2">Payment Methods other than the above types</p> * trustly - <p class="mb-2">Trustly</p> * ach_credit - <p class="mb-2">ACH Credit</p> * sepa_credit - <p class="mb-2">SEPA Credit</p> * alipay_hk - * card - <p class="mb-2">Card</p> * ideal - <p class="mb-2">IDEAL</p> * gcash - * chargeback - <p class="mb-2">Only applicable for a transaction of <code><a href="/docs/api/transactions/transaction-object#type">type</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">refund</code>. This value is set by Chargebee when an automated <a href="https://www.chargebee.com/docs/chargeback.html#chargeback-process" target="_blank" rel="noopener noreferrer">chargeback</a> occurs. You can also set this explicitly when <a href="/docs/api/transactions/record-an-offline-refund">recording a refund</a> .</p> * automated_bank_transfer - <p class="mb-2">Automated Bank Transfer</p> <span featureId="cb-bank-transfer" isMicro="true"></span> * google_pay - <p class="mb-2">Google Pay</p> * netbanking_emandates - <p class="mb-2">netbanking_emandates</p> * pay_to - <p class="mb-2">PayTo</p> <span featureId="cb-pay-to" isMicro="true"></span> * pay_by_bank - <p class="mb-2">Pay By Bank</p> * dotpay - <p class="mb-2">Dotpay</p> * alipay - <p class="mb-2">Payments made via Alipay.</p> <span featureId="cb-alipay" isMicro="true"></span> * sofort - <p class="mb-2">Sofort</p> * swish - <p class="mb-2">Payments made via Swish</p> <span featureId="cb-swish" isMicro="true"></span> * grab_pay - <p class="mb-2">Payments made via GrabPay</p> <span featureId="cb-grab-pay" isMicro="true"></span> * pix - <p class="mb-2">Pix</p> <span featureId="cb-pix" isMicro="true"></span> * giropay - <p class="mb-2">giropay</p> * pay_co - <p class="mb-2">Payments made via PayCo</p> <span featureId="cb-pay-co" isMicro="true"></span> * revolut_pay - <p class="mb-2">Payments made via Revolut Pay.</p> <span featureId="cb-revolut-pay" isMicro="true"></span> * cash - <p class="mb-2">Cash</p> * after_pay - <p class="mb-2">Payments made via Afterpay</p> <span featureId="cb-after-pay" isMicro="true"></span> * south_korean_cards -

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_payDefault "card"

<p class="mb-2">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> .</p>

Gateway through which this transaction was done. Applicable only for 'Card' Payment Method \* bluesnap - BlueSnap is a payment gateway. \* jp_morgan - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different [payment_source_type](/docs/api/payment_sources/payment_source-object#type). This feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/jp-morgan-bacs&ref=feature) to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL for your test and live sites. \* tco - 2Checkout is a payment gateway. \* payway - \* 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. \* dlocal - Dlocal provides payment solutions for global commerce by accepting local payment methods. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* paystack - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. This feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/paystack&ref=feature) to enable Paystack for your test and live sites. \* pay_com - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* 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. This feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/nuvei&ref=feature) to enable Nuvei for your test and live sites. \* eway - eWAY Account is a payment gateway. \* amazon_payments - Amazon Payments is a payment service provider. \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* bank_of_america - Bank of America Gateway \* gocardless - GoCardless is a payment service provider. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* twikey - Twikey is a payment service provider that specializes in processing direct debit payments across the EU. \* moyasar - \* deutsche_bank - Deutsche Bank is the leading German bank with strong European roots and a global network. This feature is a **Private Beta Release**. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* global_payments - Global Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* tempus - \* stripe - Stripe is a payment gateway. \* 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. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* ezidebit - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses. This feature is a **Private Beta Release**. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* paypal_pro - PayPal Pro Account is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* mollie - Mollie is a payment gateway. \* 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. This feature is a **Private Beta Release**. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.

One ofchargebeechargebee_paymentsadyenstripewepaybraintreeauthorize_netpaypal_propinewayeway_rapidworldpaybalanced_paymentsbeanstreambluepayelavonfirst_data_globalhdfcmigsnmiogonepaymillpaypal_payflow_prosage_paytcowirecardamazon_paymentspaypal_express_checkoutgocardlessorbitalmoneris_usmonerisbluesnapcybersourcevantivcheckout_compaypalingenico_directexactmollie

<p class="mb-2">Type of the transaction.</p> * authorization - <p class="mb-2">The transaction represents an authorization for capturing the <code><a href="/docs/api/transactions/transaction-object#amount">amount</a></code> from the customer&#x27;s <code><a href="/docs/api/payment_sources">payment_source</a></code> .</p> * payment - <p class="mb-2">The transaction represents capture of <code><a href="/docs/api/transactions/transaction-object#amount">amount</a></code> from the customer&#x27;s <code><a href="/docs/api/payment_sources">payment_source</a></code> .</p> * refund - <p class="mb-2">The transaction represents a refund of <code><a href="/docs/api/transactions/transaction-object#amount">amount</a></code> to the customer&#x27;s <code><a href="/docs/api/payment_sources">payment_source</a></code> .</p> * payment_reversal - <p class="mb-2">Indicates a reversal transaction.</p>

One ofauthorizationpaymentrefundpayment_reversal

Indicates when this transaction occurred.

Indicates the time at which the final status of the transaction has been marked.

Exchange rate used for base currency conversion

The currency code (ISO 4217 format) for the transaction.

Amount for this transaction.

The id with which this transaction is referred in gateway.

<p class="mb-2">The status of this transaction.</p> * in_progress - <p class="mb-2">Transaction is being processed by the gateway. This typically happens for <a href="https://www.chargebee.com/docs/direct-debit-payments.html" target="_blank">direct debit transactions</a> or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.</p> * timeout - <p class="mb-2">Transaction failed because of Gateway not accepting the connection.</p> * success - <p class="mb-2">The transaction is successful.</p> * voided - <p class="mb-2">The transaction got voided or authorization expired at gateway.</p> * needs_attention - <p class="mb-2">When connection with the Gateway gets terminated abruptly. For <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">needs_attention</code> status Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the <a href="/docs/api/transactions/reconcile-transaction">Reconcile transaction API</a>. You can use this API to update 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">id_at_gateway</code> (Gateway Transaction ID) and <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">status</code> for a <a href="/docs/api/transactions/transaction-object#status"><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">needs_attention</code></a> transaction to be reconciled at par with the gateway.</p> <div class="alert alert-info"><p class="mb-2"><a href="https://www.chargebee.com/docs/payments/2.0/needs-attention-transactions.html">Learn more</a> about <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">needs_attention</code> transaction status</p></div> * late_failure - <p class="mb-2">Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.</p> * failure - <p class="mb-2">Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure</p>

One ofin_progresssuccessvoidedfailuretimeoutneeds_attentionlate_failure

Indicates whether or not the transaction has been [identified as fraudulent](https://www.chargebee.com/docs/payments/2.0/fraud-management/chargebee-fraud-management). \* suspicious - The transaction has been identified as potentially fraudulent by the gateway \* safe - The transaction has been marked as safe \* fraudulent - The transaction has been marked as fraudulent

One ofsafesuspiciousfraudulent

Marker for on-session payments (3DS). null indicates 'merchant'. \* merchant - Payment initiated on stored payment method by the merchant \* customer - Customer initiated 3DS payment

One ofcustomermerchant

Indicates whether this transaction has gone through 3DS. Applicable only for 'on-session' payments \& verifications.If 3DS is not enforced by the gateway/bank or if the customers' card is not enrolled, this will be false.

<p class="mb-2">Type of authorization transaction.</p> * scheduled_capture - <p class="mb-2">The transaction was authorized in advance for capture at a later time by a scheduled system job. The capture may succeed or fail, and its outcome is recorded as a linked transaction under <code><a href="">linked_payments</a></code> .</p> * verification - <p class="mb-2">The transaction has been created for payment method verification.</p> * blocking_funds - <p class="mb-2">The transaction has been created to block the funds from payment method.</p>

One ofblocking_fundsverificationscheduled_capture

Error code received from the payment gateway on failure.

Error message received from the payment gateway on failure.

Timestamp indicating when the payment was voided or authorization expired at gateway.

<p class="mb-2">Version number of this resource. 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">resource_version</code> is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>

Timestamp indicating when this transaction was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.

Short description why the transaction was marked as fraud/suspicious

Identifier of the custom payment method of this transaction.

<p class="mb-2">This is the part of 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">amount</code> which has not been invoiced yet and is therefore added to <code><a href="/docs/api/customers/customer-object#excess_payments">excess_payments</a></code> for the customer. Applicable only for a transaction 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">type</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">payment</code> .</p>

The masked card number used for this transaction. Applicable only for 'Card' Payment Method

<p class="mb-2">This is 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">id</code> of the offline transaction that is being refunded or reversed. Applicable only for transaction 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">type</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">refund</code> or <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">payment_reversal</code> .</p>

<p class="mb-2">This is 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">id</code> of the transaction (always 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">type</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">payment</code> ) being refunded. Applicable only for transaction 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">type</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">refund</code> .</p>

<p class="mb-2">This is 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">id</code> of the transaction (always 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">type</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">authorization</code> ) which authorizes the payment being captured. Applicable only for transaction 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">type</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">payment</code> .</p>

<p class="mb-2">This is the part of the authorized <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">amount</code> that is yet to be captured. The payment capture is recorded as a transaction of 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">type</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">payment</code>. Applicable only for a transaction 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">type</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">authorization</code> .</p>

Reversal transaction id. Applicable only for payment transactions.

Indicates that this resource has been deleted.

First 6 digits of the card payment method.

Last 4 digits of the card payment method.

A unique id used to track this transaction across various systems you integrate with. This id is passed to the payment gateway when the transaction is initiated. Supported only for the [Exact payment gateway](https://www.chargebee.com/docs/exact-direct.html) .

<p class="mb-2">The unique ID of the <a href="/docs/api/getting-started">business entity</a> of this <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">transaction</code>. This is always the same as the business entity of the <a href="/docs/api/transactions/transaction-object#customer_id">customer</a>.</p> <span featureId="cb-mbe" isMicro="true"></span>

Payment method details of the corresponding transaction