Skip to main content

Real-Time Reconciliation events for GoCardless

Zuora

Real-Time Reconciliation events for GoCardless

The following table lists Zuora's actions on GoCardless events when the Real-time Gateway Reconciliation feature is enabled. 

The GoCardless Webhook service might delay sending notifications to Zuora for 2 or 3 days. The corresponding records in Zuora will not be updated until the notifications from GoCardless are received. If you have any questions about this delay, please contact GoCardless.

GoCardless event type GoCardless event Zuora action
Mandate created Zuora ignores this event because the payment method is created.
customer_approval_granted N/A
customer_approval_skipped N/A
active N/A
submitted N/A
reinstated N/A
cancelled Zuora closes the payment method.
failed Zuora closes the payment method.
transferred N/A
expired Zuora closes the payment method.
resubmission_requested N/A
replaced N/A
Payment customer_approval_denied
  • Zuora updates the Gateway State to "Failed to Settle" on the Payment transaction.
  • 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.
confirmed Zuora updates the Gateway State to "Settled" and the Settled On date field of the Payment event.
cancelled
  • Zuora updates the Gateway State to "Failed to Settle" on the Payment transaction.
  • 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.
failed
  • Zuora updates the Gateway State to "Failed to Settle" on the Payment transaction.
  • 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.
charged_back
  • Zuora updates the Gateway State to "Settled" on the Payment transaction.
  • Zuora creates an External Refund.
chargeback_cancelled N/A
late_failure_settled
  • Zuora updates the Gateway State to "Settled" on the Payment transaction.
  • Zuora creates an External Refund.
created N/A
customer_approval_granted N/A
submitted N/A
paid_out N/A
chargeback_settled N/A
surcharge_fee_credited N/A
surcharge_fee_debited N/A
Refund paid Zuora updates the Gateway State to "Settled" on the refund transaction.
refund_settled Zuora updates the Gateway State to "Settled" on the refund transaction.
created N/A
failed Zuora updates the Gateway State to "Reject" on the refund transaction and reverses the refund according to the global setting configured in the Gateway Reconciliation Configuration page in Zuora Payments Settings.
refund_returned Zuora updates the Gateway State to "Reject" on the refund transaction and reverses the refund according to the global setting configured in the Gateway Reconciliation Configuration page in Zuora Payments Settings.
Payout paid

Zuora updates the payment or refund with payout_id.

Note: Zuora updates payout_id only if any one of the following payment or refund events is received before receiving the payout event. Zuora then updates the payment or refund with the updated payout_id. If none of the following events is received by Zuora before receiving the payout event, Zuora ignores the payout event.

  • Payment:
    • failed
    • cancelled
    • customer_approval_denied
    • confirmed
    • late_failure_settled
    • charged_back
  • Refund:
    • paid
    • refund_settled
    • funds_returned
    • failed
fx_rate_confirmed N/A
tax_exchange_rates_confirmed N/A