Skip to main content

Real-Time Reconciliation events for PayPal Commerce Platform

Zuora

Real-Time Reconciliation events for PayPal Commerce Platform

  1. Last updated
  2. Save as PDF

Zuora supports the following events for Real-Time Reconciliation on PayPal Commerce Platform:

PayPal object Zuora object PayPal event Zuora action
Payment Payment PAYMENT.CAPTURE.COMPLETED
  • Zuora updates Gateway State to Settled on the payment transaction.
  • Zuora updates Gateway Reconciliation Status to COMPLETED and populates Gateway Reconciliation Reason.
Payment Payment PAYMENT.CAPTURE.DECLINED
  • Zuora updates Gateway State to "FailedToSettle" on the payment transaction. Gateway Reconciliation Reason is populated with the reason information and Gateway Reconciliation Status is set to DECLINED or DENIED.
  • 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 Payment PAYMENT.CAPTURE.DENIED
Payment Payment PAYMENT.CAPTURE.REVERSED
  • Zuora updates Gateway State to "Settled" on the payment transaction.
  • By default, Zuora creates an external refund. 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 you want to opt out of this default behavior and disable the generation of external refunds for dispute events, submit a request at Zuora Global Support.
  • Zuora updates Gateway Reconciliation Status of the payment to COMPLETED.
  • Zuora updates Gateway Reconciliation Reason of the payment with the corresponding message.
Payment Refund PAYMENT.CAPTURE.REFUNDED
  • Zuora updates Gateway State to Settle on the refund transaction.
  • Zuora updates Gateway Reconciliation Status to COMPLETED and populates Gateway Reconciliation Reason.
Disputes Payment CUSTOMER.DISPUTE.RESOLVED
  • Zuora updates Gateway State to Settled on the refund transaction.
  • Zuora creates an external refund 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.
  • No value is populated in Gateway Reconciliation Status is set to CHARGEBACK and Gateway Reconciliation Reason is populated.

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