Welcome to Zuora Product Documentation

Explore our rich library of product information

Real-Time Reconciliation events for Checkout.com

Zuora supports various event types for real-time reconciliation with Checkout.com, including payment captured, payment voided, payment declined, and more, to manage payment transactions and refunds effectively.

Zuora supports the following event types for Real-Time Reconciliation on Checkout.com:

Zuora object

Checkout.com event

Zuora GR event

Zuora action

Payment

payment_captured

TransactionSettled

  • Zuora handles this event for processed payments. Error payments will not be reconciled.

  • If the event is successful, Zuora updates the Gateway State to "Settled" on the Payment transaction. No value is populated in the Gateway Reconciliation Reason.

payment_voided

TransactionRejected

  • Zuora updates the Gateway State to "FailedToSettle" on the payment transaction. The Gateway Reconciliation Reason and Gateway Reconciliation Status are populated.

  • Zuora creates an external refund with the reason code set to "Payment Rejection" if the code is active in the Reason Codes list . Otherwise, Zuora creates an external refund with the reason code set to the default reason code in the list.

  • If the Support refunding payments from the credit balance with Gateway Reconciliation setting is enabled, a credit balance refund will be created. See Refund payments with credit balance in gateway reconciliation for more information.

payment_declined

TransactionRejected

  • Zuora updates the Gateway State to "FailedToSettle" on the payment transaction. The Gateway Reconciliation Reason and Gateway Reconciliation Status are populated.

  • Zuora creates an external refund with the reason code set to "Payment Rejection" if the code is active in the Reason Codes list . Otherwise, Zuora creates an external refund with the reason code set to the default reason code in the list.

  • If the Support refunding payments from the credit balance with Gateway Reconciliation setting is enabled, a credit balance refund will be created. See Refund payments with credit balance in gateway reconciliation for more information.

payment_capture_declined

TransactionRejected

  • Zuora updates the Gateway State to "FailedToSettle" on the payment transaction. The Gateway Reconciliation Reason and Gateway Reconciliation Status are populated.

  • Zuora creates an external refund with the reason code set to "Payment Rejection" if the code is active in the Reason Codes list . Otherwise, Zuora creates an external refund with the reason code set to the default reason code in the list.

  • If the Support refunding payments from the credit balance with Gateway Reconciliation setting is enabled, a credit balance refund will be created. See Refund payments with credit balance in gateway reconciliation for more information.

payment_returned

TransactionRejected

  • Zuora updates the Gateway State to "FailedToSettle" on the payment transaction. The Gateway Reconciliation Reason and Gateway Reconciliation Status are populated.

  • Zuora creates an external refund with the reason code set to "Payment Rejection" if the code is active in the Reason Codes list . Otherwise, Zuora creates an external refund with the reason code set to the default reason code in the list.

  • If the Support refunding payments from the credit balance with Gateway Reconciliation setting is enabled, a credit balance refund will be created. See Refund payments with credit balance in gateway reconciliation for more information.

payout_paid

-

If the event is successful, Zuora updates the payment with the payout ID. No value is populated in the Gateway Reconciliation Status or the Gateway Reconciliation Reason

dispute_lost

TransactionReversed

Zuora handles this event for processed payments. Error payments will not be reconciled.

If the event is successful:

  • Zuora creates an external refund only if the chargeback currency is the same as the payment currency. If "Payment Reversal" is active in the Reason Codes list , the reason code is set to "Payment Reversal". Otherwise, the reason code is set to the default reason code in the list.

  • If the Support refunding payments from the credit balance with Gateway Reconciliation setting is enabled, a credit balance refund will be created. See Refund payments with credit balance in gateway reconciliation for more information.

If you do not want Zuora to create refunds for chargeback events, submit a request to Zuora Global Support .

dispute_acceptedTransactionReversed

Zuora handles this event as a terminal dispute outcome for processed payments. Zuora populates the Gateway Reconciliation Status with the event type and the Gateway Reconciliation Reason with the dispute category on the payment. If the event is successful, Zuora creates an external refund only if the chargeback currency is the same as the payment currency. If Payment Reversal is active in the Reason Codes list, the reason code is set to Payment Reversal. Otherwise, the reason code is set to the default reason code in the list. If the Support refunding payments from the credit balance with Gateway Reconciliation setting is enabled, a credit balance refund will be created. If you do not want Zuora to create refunds for chargeback events, submit a request to Zuora Global Support.

dispute_expiredTransactionReversed

Zuora handles this event as a terminal dispute outcome for processed payments. Zuora populates the Gateway Reconciliation Status with the event type and the Gateway Reconciliation Reason with the dispute category on the payment. If the event is successful, Zuora creates an external refund only if the chargeback currency is the same as the payment currency. If Payment Reversal is active in the Reason Codes list, the reason code is set to Payment Reversal. Otherwise, the reason code is set to the default reason code in the list. If the Support refunding payments from the credit balance with Gateway Reconciliation setting is enabled, a credit balance refund will be created. If you do not want Zuora to create refunds for chargeback events, submit a request to Zuora Global Support.

dispute_received-

A reconciliation event is produced and consumed for this Update event. On the matched payment, Zuora sets the Gateway Reconciliation Status to Dispute Received and the Gateway Reconciliation Reason to a comma-separated dispute summary that includes the reason code, currency, amount, category, and event date. Zuora does not create an external refund until a later dispute outcome event is received.

Refund

payment_refunded

TransactionSettled

Zuora handles this event for processed refunds. Error refunds will not be reconciled.

If the event is successful, Zuora updates the Gateway State to "Settled" on the refund transaction. No value is populated in Gateway Reconciliation Status or Gateway Reconciliation Reason.

payment_refund_declinedTransactionRejected

Zuora handles this event for processed refunds. If the event is successful, Zuora updates the Gateway State to FailedToSettle on the refund transaction. The Gateway Reconciliation Reason and Gateway Reconciliation Status are populated. Zuora does not create an external refund for this event because the refund attempt itself was declined.