POST /transactions/{transaction-id}/reconcile

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.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`transaction-id`	String	Yes

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 Valid 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 Valid 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 Valid values: `"all-disabled"`

Request body fields

Name Type Required Description

Name	Type	Required	Description
`id_at_gateway`	String	No	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_attention` to `success`. It is recommended to pass this value if available in the gateway. An error occurs when the provided `id_at_gateway` value does not match the `id_at_gateway` value stored against the transaction in Chargebee.
`customer_id`	String	No	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.
`status`	String	No	The status of this transaction. The status can only be updated when the transaction status is in `needs_attention` state. failure - When the transaction is in failure status. Note: When the transaction is updated to `failure` status and the invoice is associated with the transaction, the invoice will be moved to the `payment_due` status if the `dunning` is configured. the invoice will be moved to the `not_paid` status if the `dunning` is not configured. success - When the transaction is successful. Note:When the transaction is updated to `success` status, and the invoice is associated with the transaction, the transaction `amount` will be applied to the invoice. and no invoice is associated but the customer is associated with the transaction, `customer_excess_payments` will be updated. Valid values: `"success"` `"failure"`

id_at_gateway

String

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_attention to success. It is recommended to pass this value if available in the gateway.
An error occurs when the provided id_at_gateway value does not match the id_at_gateway value stored against the transaction in Chargebee.

customer_id

String

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.

status

String

The status of this transaction. The status can only be updated when the transaction status is in needs_attention state.

failure - When the transaction is in failure status.
Note:
When the transaction is updated to failure status and the invoice is associated with the transaction,
- the invoice will be moved to the payment_due status if the dunning is configured.
- the invoice will be moved to the not_paid status if the dunning is not configured.
success - When the transaction is successful.
Note:When the transaction is updated to success status,
- and the invoice is associated with the transaction, the transaction amount will be applied to the invoice.
- and no invoice is associated but the customer is associated with the transaction, customer_excess_payments will be updated.

Valid values:

"success"
"failure"

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.