Refund reason codes

Reason codes explain the current status of a refund. Use the code value for programmatic handling. The cause explains what happened; the integration next action explains what your integration should do.

Getpaid normalizes result codes across routes so you can act on a pre-defined set of known codes.

Declined

Code	Cause	Integration next action
already_refunded	A previous refund or credit prevents another refund for the payment.	Fetch the payment and inspect its totals.refunded, totals.refundable, and refunds; do not create another refund.
declined	The payment network declined the refund.	Contact Getpaid support with the refund id or arrange another reimbursement method.
exceeds_captured_amount	The refund exceeds the remaining refundable amount.	Fetch the payment and check totals.refundable and refunds; reduce the amount and create a new refund.
refund_period_expired	The network refund period has expired.	Fetch the payment and check created_at; arrange another reimbursement method.
refund_unavailable	Refunds are unavailable for this payment.	Fetch the payment and check status and totals.refundable before creating another refund.

Failed

Code	Cause	Integration next action
unavailable	A downstream payment service is unavailable.	Retry later. Contact Getpaid support with the refund id if it persists.
unexpected	An unexpected refund-processing error occurred.	Do not repeatedly retry. Contact Getpaid support with the payment and refund IDs.
provider_unavailable	A downstream provider is unavailable.	Retry later. Contact Getpaid support with the refund id if it persists.
unknown_error	An unknown error occurred.	Retry later. Contact Getpaid support with the refund id if it persists.