Settings
Configure SDK
Transactions
This resource represents the transaction event that has happened in your account.
Sample transaction [ JSON ]
{
"amount": 1000,
"amount_capturable": 1000,
"authorization_reason": "blocking_funds",
"currency_code": "USD",
"customer_id": "__test__KyVnHhSBWltgF2p6",
"date": 1600968316,
"deleted": false,
"exchange_rate": 1,
"fraud_reason": "Payment complete.",
"gateway": "stripe",
"gateway_account_id": "gw___test__KyVnGlSBWltbL2AB",
"id": "txn___test__KyVnHhSBWltv42pB",
"id_at_gateway": "ch_1HUyC0Jv9j0DyntJiR6W37yv",
"linked_payments": [],
"masked_card_number": "************1111",
"object": "transaction",
"payment_method": "card",
"payment_source_id": "pm___test__KyVnHhSBWltu42p7",
"resource_version": 1517505917000,
"status": "success",
"type": "authorization",
"updated_at": 1517505917
}API Index URL
The reference number for this transaction. For example, the check number when payment_method
= check
.
This is the part of the amount
which has not been invoiced yet and is therefore added to excess_payments
for the customer. Applicable only for a transaction of type
= payment
.
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 .
The unique ID of the business entity
of this transaction.
This is always the same as the business entity of the customer.
Applicable only for 'Payment' transactions. The list of invoices this 'payment' transaction is applied to.
Applicable only for 'Refund' transactions. The list of Credit Notes this 'refund' transaction is associated with.
Applicable only for Payment transactions. It only returns values when the transaction is not associated with an invoice, and that there is a refund for the transaction.
The list of payments captured for this authorization transaction.
Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about gateway error references
Create an authorization payment ¶
Authorizes a specific amount in customer's Credit card, which can be collected within a span of time. Read more on authorization and capture here.
- Supported only for Card payments.
- Currently supported only for Stripe.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Returns
Resource object representing transaction
Void an authorization transaction ¶
This API voids the specific authorization transaction in order to release the blocked funds from the customer's card. Voiding an already captured or voided transaction is not possible.
Sample Response [ JSON ]
URL Format POST
Returns
Resource object representing transaction
Record an offline refund ¶
Records a refund made offline. Applicable only for transactions of type = payment.
Sample Response [ JSON ]
URL Format POST
Input Parameters
The amount to be recorded as refunded. Must not exceed amount_unused.
If not passed then all of amount_unused
is recorded as refunded.
Returns
Resource object representing transaction
Reconcile transaction ¶
Update selected attributes of the transaction resource: status, id_at_gateway, and customer_id. Use this API for reconciliation purposes where the status of a transaction is in needs_attention that can be updated to either success or failure status.
Sample Response [ JSON ]
URL Format POST
Input Parameters
The identifier with which this transaction is referred in gateway. The id_at_gateway
can only be updated when the transaction status is in needs_attention.
Note:
- It is mandatory to pass this parameter value for updating the transaction status from
needs_attentiontosuccess. It is recommended to pass this value if available in the gateway. - An error occurs when the provided
id_at_gatewayvalue does not match theid_at_gatewayvalue stored against the transaction in Chargebee.
Unique identifier of the customer for which this transaction is made. This is needed only when the transaction is successful but not associated with any customer.
Note:
An error occurs when the provided customer_id
value does not match the customer_id
value stored against the transaction in Chargebee.
The status of this transaction. The status can only be updated when the transaction status is in needs_attention
state.
Returns
Resource object representing transaction
Refund a payment ¶
Sample Response [ JSON ]
URL Format POST
Input Parameters
The amount to be refunded. Must not exceed amount_unused.
If not passed then all of amount_unused
is refunded.
Returns
Resource object representing transaction
List transactions ¶
Lists all the transactions.
Sample Response [ JSON ]
URL Format GET
Input Parameters
Filter Params
For operator usages, see the Pagination and Filtering section.
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"
Supported operators : is, is_not, starts_with, is_present, in, not_in
Example → customer_id[is] = "5hjdk8nOpd"
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"
Supported operators : is, is_not, starts_with, is_present, in, not_in
Example → subscription_id[is] = "5hjdk8nOpd"
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"
Supported operators : is, is_not, starts_with, is_present, in, not_in
Example → payment_source_id[is] = "pm_3Nl8XXUQUXDVFa2"
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, custom, boleto, venmo, pay_to, faster_payments, sepa_instant_transfer, automated_bank_transfer, klarna_pay_now, online_banking_poland, payconiq_by_bancontactSupported operators : is, is_not, in, not_in
Example → payment_method[is] = "card"
Gateway through which this transaction was done. Applicable only for 'Card' Payment Method.
Possible values are : chargebee, chargebee_payments, adyen, 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, orbital, moneris_us, moneris, bluesnap, cybersource, vantiv, checkout_com, paypal, ingenico_direct, exact, mollie, quickbooks, razorpay, global_payments, bank_of_america, ecentric, metrics_global, windcave, pay_com, ebanx, dlocal, nuvei, solidgate, paystack, jp_morgan, deutsche_bank, ezidebit, not_applicableSupported operators : is, is_not, in, not_in
Example → gateway[is] = "stripe"
The gateway account used for this transaction. Supported operators : is, is_not, starts_with, in, not_in
Example → gateway_account_id[is] = "gw_3Nl9BNeQ7438Ks1"
Supported operators : is, is_not, starts_with, in, not_in
Example → gateway_account_id[is] = "gw_3Nl9BNeQ7438Ks1"
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"
Supported operators : is, is_not, starts_with
Example → id_at_gateway[is] = "txn_5678HJS89900"
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"
Supported operators : is, is_not, starts_with, is_present
Example → reference_number[is] = "cus_u239732"
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"
Supported operators : is, is_not, lt, lte, gt, gte, between
Example → amount_capturable[is] = "1200"
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"
Supported operators : after, before, on, between
Example → updated_at[after] = "1243545465"
Returns
Resource object representing transaction
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.
List payments for an invoice ¶
Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual & automatic) made for this invoice.
Sample Response [ JSON ]
URL Format GET
Input Parameters
Returns
Resource object representing transaction
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.
Retrieve a transaction ¶
Retrieve a transaction identified by its unique id.
Sample Response [ JSON ]
URL Format GET
Returns
Resource object representing transaction
Sample admin console URL
Delete an offline transaction ¶
This API deletes an offline transaction. However, to delete an offline transaction all payment allocations associated with the transaction must be removed.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Returns
Resource object representing transaction