/v1/charges/{charge}/refunds/{refund}Update a specified refund.
| Name | Description |
|---|---|
| charge* | |
| refund* |
| Field | Type | Description |
|---|---|---|
| expand | array<string> | Specifies which fields in the response should be expanded. |
| metadata | object | string |
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| amount* | integer | Amount, in cents (or local equivalent). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| balance_transaction | string | balance_transaction | Balance transaction that describes the impact on your account balance. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| charge | string | charge | ID of the charge that's refunded. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created* | integer (unix-time) | Time at which the object was created. Measured in seconds since the Unix epoch. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| currency* | string (currency) | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description | string | An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| destination_details | refund_destination_details | 30 nested fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| failure_balance_transaction | string | balance_transaction | After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| failure_reason | string | Provides the reason for the refund failure. Possible values are: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id* | string | Unique identifier for the object. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| instructions_email | string | For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| metadata | object | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| next_action | refund_next_action | 2 nested fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| object* | string | String representing the object's type. Objects of the same type share the same value. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| payment_intent | string | payment_intent | ID of the PaymentIntent that's refunded. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| pending_reason | string | Provides the reason for why the refund is pending. Possible values are: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| presentment_details | payment_flows_payment_intent_presentment_details | 2 nested fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| reason | string | Reason for the refund, which is either user-provided ( | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receipt_number | string | This is the transaction number that appears on email receipts sent for this refund. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| source_transfer_reversal | string | transfer_reversal | The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string | Status of the refund. This can be | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transfer_reversal | string | transfer_reversal | This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. |