GoCardlessDeveloper Docs
Create a sandbox account

Payout Events

Event types and causes for payout resources.

GoCardless has transferred the payout to the creditor's bank account. The details[cause] will always be payout_paid, and the details[origin] will be gocardless.

gocardlesspayout_paid

GoCardless has transferred the payout to the creditor's bank account. FX payouts will emit this event but will continue to have a pending status until we emit the payout_fx_rate_confirmed event.

Fx Rate Confirmed#

The exchange rate for the payout has been confirmed and will not change.

gocardlesspayout_fx_rate_confirmed

The exchange rate for the payout has been confirmed and will not change. Only sent for FX payouts.

Tax Exchange Rates Confirmed#

The tax exchange rates for all payout items of the payout have been confirmed. This event will only exist if the payout has a tax_currency and if its tax_currency is different from its currency. It will be created once all fees in the payout are invoiced.

gocardlesspayout_tax_exchange_rates_confirmed

The exchange rates for the taxes (such as VAT) that applied to GoCardless fees deducted from the payout have all been confirmed and will not change.

GoCardless has transferred the payout to the creditor's bank account again after a bounced payout. The details[cause] will always be payout_paid_again, and the details[origin] will be gocardless.

gocardlesspayout_paid_again

GoCardless has transferred the payout to the creditor's bank account again after a bounced payout

SupportDashboard