Skip to main content
Prices in this command’s output are integers in minor units. Money objects carry decimal_places — divide by 10 ** decimal_places to display ({ "value": 15977, "decimal_places": 2 } is 159.77, not 15,977). See Money & prices.
Poll the current status of a previously committed refund.

Usage

Options

Examples

For refund_status, terminal values are SUCCEEDED, FAILED, and CANCELLED. PENDING and IN_PROGRESS are still running; MANUAL_REQUIRED and UNCONFIRMED are not terminal. For the platform’s state field, succeeded and failed are terminal; keep polling for in_progress or attention_required. Treat unknown refund_status values as still running and inspect state. Poll every 15-30s until terminal.