Real-Time Reconciliation events for EBANX
Zuora supports various event types for Real-Time Reconciliation on EBANX, including payment, refund, and mandate events, with specific actions on the gateway state.
Payment
Zuora supports the following payment-related webhook event mappings for Real-Time Reconciliation with EBANX.
EBANX Event | Zuora GR Operation | Zuora Behavior |
notification_type: update with status CO (Confirmed) | Settle Payment | Zuora updates Payment.GatewayReconciliationStatus to the payment status. If the Asynchronous Payment Statuses feature is not enabled, Zuora sets the payment Gateway State to Settled. If the feature is enabled, for ACH and Bank Transfer payments, Zuora sets Payment Status to Processed and Gateway State to Settled. |
notification_type: update with status CA (Cancelled) | Reject Payment | Zuora updates Payment.GatewayReconciliationStatus to the payment status and populates Payment.GatewayReconciliationReason with the transaction status code and description. If the Asynchronous Payment Statuses feature is not enabled, Zuora sets the payment Gateway State to FailedToSettle, creates a refund for the payment amount, and returns the Refund object. If the feature is enabled, for ACH and Bank Transfer payments, Zuora sets Payment Status to Error, sets Gateway State to FailedToSettle, and unapplies the payment if it has already been applied. If the Payment Rejection reason code is active, Zuora uses it for the external refund; otherwise, Zuora uses the default reason code. |
Additional behavior for externally initiated chargebacks
If Asynchronous Payment Statuses is disabled, reverse a payment and Zuora creates a standard Refund object. Your integration must then call the API to directly create the chargeback record.
If Asynchronous Payment Statuses is enabled, reverse a payment and Zuora creates an External Refund object. Your integration must call the same API to log the externally initiated chargeback.
Refund
Zuora supports the following refund-related webhook event mappings for Real-Time Reconciliation with EBANX.
EBANX Event | Zuora GR Operation | Zuora Behavior |
notification_type: refund with status CO (Confirmed) | Reconcile Refund + settle | Zuora updates Refund.GatewayReconciliationStatus to the refund status with Confirmed, sets Gateway State to Settled, and returns the refund object. |
notification_type: refund with status RE (Requested) | N/A | No action. |
notification_type: refund with status PE (Pending) | N/A | No action. |
notification_type: refund with status CA (Cancelled) | Reconcile Refund + reject | Zuora updates Refund.GatewayReconciliationStatus to the refund status with Cancelled, sets Gateway State to FailedToSettle, and handles the event according to the rejected-refund behavior configured in Gateway Reconciliation Configuration in Payments Settings. |
Payment method or mandate
Zuora supports the following enrollment-related webhook event mappings for payment methods or mandates.
EBANX Event | Zuora GR Operation | Zuora Behavior |
notification_type: update with status accepted | Activate Payment Method if inactive | The associated payment method enrollment has been activated by the user, so Zuora should activate the payment method if it is not already active. |
notification_type: update with status revoked | Close Payment Method | The associated payment method enrollment has been revoked by the user, so Zuora should close the payment method to prevent future debiting. |