GoCardlessDeveloper Docs
Create a sandbox account

Refund Events

Event types and causes for refund resources.

Created#

A refund has been created. The details[cause] will be payment_refunded, and the details[origin] will be api.

apipayment_refunded

The refund has been created, and will be submitted in the next batch.

apirefund_created

The refund has been created, and will be submitted in the next batch.

Failed#

The refund did not reach your customer, the funds will be returned to you. The details[cause] will be refund_failed, and the details[origin] will be gocardless.

It is important to note that the 'failed' and 'refund_settled' events are not associated. A refund can fail even after it's been settled. If a refund fails, GoCardless has attempted to refund the customer and has already deducted the applicable funds from one of your payouts. The refund has then subsequently failed to reach the customer. If this occurs, the funds will be returned to you.

gocardlessrefund_failed

The refund did not reach your customer, the funds will be returned to you.

The refund has been paid to your customer. The details[cause] will be refund_paid, and the details[origin] will be gocardless.

gocardlessrefund_paid

The refund has been paid to your customer.

Refund Settled#

The refund has been deducted from a payout. The details[cause] will be refund_settled, and the details[origin] will be gocardless.

gocardlessrefund_settled

The refund has been deducted from a payout.

Funds Returned#

The refund has been credited in a payout. The details[cause] will be refund_funds_returned, and the details[origin] will be gocardless.

gocardlessrefund_funds_returned

The funds for the refund have been returned to you.

Was this helpful?
SupportDashboard