Stripe: Refunds schemas

11 Stripe schemas with complete fields and constraints.

Cancel a refund — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged. Related guide: [Refunds](https://docs.stripe.com/refunds)
`amount`	JSON	Required within parent
`amount (anyOf 1)`	integer	Alternative	Amount, in cents (or local equivalent).
`amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`balance_transaction`	JSON	Optional
`balance_transaction (anyOf 1)`	JSON	Alternative	Balance transaction that describes the impact on your account balance.
`balance_transaction (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`balance_transaction (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Retrieve a balance transaction — balance get Balance History Id — response body
`balance_transaction (anyOf 2)`	null	Alternative
`charge`	JSON	Optional
`charge (anyOf 1)`	JSON	Alternative	ID of the charge that's refunded.
`charge (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`charge (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a charge — response body
`charge (anyOf 2)`	null	Alternative
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`currency`	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency
`customer`	JSON	Optional
`customer (anyOf 1)`	JSON	Alternative	ID of the customer of this refund.
`customer (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`customer (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a customer — response body
`customer (anyOf 1) (anyOf 3)`	Model	Alternative	Expand Delete a customer — response body
`customer (anyOf 2)`	null	Alternative
`customer_account`	JSON	Optional
`customer_account (anyOf 1)`	string	Alternative	ID of the account of this refund. Maximum length: 5000
`customer_account (anyOf 2)`	null	Alternative
`description`	string	Optional	An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). Maximum length: 5000
`destination_details`	Model	Optional	Expand Cancel a refund — response body — destination details
`failure_balance_transaction`	JSON	Optional	After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
`failure_balance_transaction (anyOf 1)`	string	Alternative	Maximum length: 5000
`failure_balance_transaction (anyOf 2)`	Model	Alternative	Expand Retrieve a balance transaction — balance get Balance History Id — response body
`failure_reason`	string	Optional	Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`. Maximum length: 5000
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`instructions_email`	string	Optional	For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. Maximum length: 5000
`metadata`	JSON	Optional
`metadata (anyOf 1)`	object	Alternative	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
`metadata (anyOf 1).*`	string	Additional keys	Maximum length: 500
`metadata (anyOf 2)`	null	Alternative
`next_action`	Model	Optional	Expand Cancel a refund — response body — next action
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: refund
`payment_intent`	JSON	Optional
`payment_intent (anyOf 1)`	JSON	Alternative	ID of the PaymentIntent that's refunded.
`payment_intent (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`payment_intent (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Cancel a Payment Intent — response body
`payment_intent (anyOf 2)`	null	Alternative
`payment_method`	JSON	Optional
`payment_method (anyOf 1)`	JSON	Alternative	ID of the payment method associated with this refund.
`payment_method (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`payment_method (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a Payment Method — response body
`payment_method (anyOf 2)`	null	Alternative
`pending_reason`	string	Optional	Provides the reason for why the refund is pending. Possible values are: `processing`, `insufficient_funds`, or `charge_pending`. Known values: charge_pending, insufficient_funds, processing
`presentment_details`	Model	Optional	Expand Cancel a refund — response body — presentment details
`reason`	JSON	Optional
`reason (anyOf 1)`	string	Alternative	Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). Known values: duplicate, expired_uncaptured_charge, fraudulent, requested_by_customer
`reason (anyOf 2)`	null	Alternative
`receipt_number`	JSON	Optional
`receipt_number (anyOf 1)`	string	Alternative	This is the transaction number that appears on email receipts sent for this refund. Maximum length: 5000
`receipt_number (anyOf 2)`	null	Alternative
`source_transfer_reversal`	JSON	Optional
`source_transfer_reversal (anyOf 1)`	JSON	Alternative	The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.
`source_transfer_reversal (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`source_transfer_reversal (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Update a reversal — response body
`source_transfer_reversal (anyOf 2)`	null	Alternative
`status`	JSON	Optional
`status (anyOf 1)`	string	Alternative	Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://docs.stripe.com/refunds#failed-refunds). Maximum length: 5000
`status (anyOf 2)`	null	Alternative
`transfer_reversal`	JSON	Optional
`transfer_reversal (anyOf 1)`	JSON	Alternative	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.
`transfer_reversal (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`transfer_reversal (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Update a reversal — response body
`transfer_reversal (anyOf 2)`	null	Alternative

Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body, Create a charge — response body, Create a customer — response body, Delete a customer — response body, Cancel a refund — response body — presentment details, Cancel a Payment Intent — response body, Create a Payment Method — response body, Cancel a refund — response body — destination details, Cancel a refund — response body — next action, Update a reversal — response body

Cancel a refund — response body — destination details

Field	Type	Presence	Description and constraints
`$`	object	Root
`affirm`	Model	Optional	Expand Create a Payment Method — response body — zip
`afterpay_clearpay`	Model	Optional	Expand Create a Payment Method — response body — zip
`alipay`	Model	Optional	Expand Create a Payment Method — response body — zip
`alma`	Model	Optional	Expand Create a Payment Method — response body — zip
`amazon_pay`	Model	Optional	Expand Create a Payment Method — response body — zip
`au_bank_transfer`	Model	Optional	Expand Create a Payment Method — response body — zip
`blik`	Model	Optional	Expand Cancel a refund — response body — destination details blik
`br_bank_transfer`	Model	Optional	Expand Cancel a refund — response body — destination details p24
`card`	Model	Optional	Expand Cancel a refund — response body — destination details card
`cashapp`	Model	Optional	Expand Create a Payment Method — response body — zip
`crypto`	Model	Optional	Expand Cancel a refund — response body — destination details crypto
`customer_cash_balance`	Model	Optional	Expand Create a Payment Method — response body — zip
`eps`	Model	Optional	Expand Create a Payment Method — response body — zip
`eu_bank_transfer`	Model	Optional	Expand Cancel a refund — response body — destination details p24
`gb_bank_transfer`	Model	Optional	Expand Cancel a refund — response body — destination details p24
`giropay`	Model	Optional	Expand Create a Payment Method — response body — zip
`grabpay`	Model	Optional	Expand Create a Payment Method — response body — zip
`jp_bank_transfer`	Model	Optional	Expand Cancel a refund — response body — destination details p24
`klarna`	Model	Optional	Expand Create a Payment Method — response body — zip
`mb_way`	Model	Optional	Expand Cancel a refund — response body — destination details p24
`multibanco`	Model	Optional	Expand Cancel a refund — response body — destination details p24
`mx_bank_transfer`	Model	Optional	Expand Cancel a refund — response body — destination details p24
`nz_bank_transfer`	Model	Optional	Expand Create a Payment Method — response body — zip
`p24`	Model	Optional	Expand Cancel a refund — response body — destination details p24
`paynow`	Model	Optional	Expand Create a Payment Method — response body — zip
`paypal`	Model	Optional	Expand Cancel a refund — response body — destination details paypal
`pix`	Model	Optional	Expand Create a Payment Method — response body — zip
`revolut`	Model	Optional	Expand Create a Payment Method — response body — zip
`scalapay`	Model	Optional	Expand Create a Payment Method — response body — zip
`sofort`	Model	Optional	Expand Create a Payment Method — response body — zip
`swish`	Model	Optional	Expand Cancel a refund — response body — destination details blik
`th_bank_transfer`	Model	Optional	Expand Cancel a refund — response body — destination details p24
`twint`	Model	Optional	Expand Create a Payment Method — response body — zip
`type`	string	Required within parent	The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction. Maximum length: 5000
`us_bank_transfer`	Model	Optional	Expand Cancel a refund — response body — destination details p24
`wechat_pay`	Model	Optional	Expand Create a Payment Method — response body — zip
`zip`	Model	Optional	Expand Create a Payment Method — response body — zip

Referenced models: Create a Payment Method — response body — zip, Cancel a refund — response body — destination details blik, Cancel a refund — response body — destination details p24, Cancel a refund — response body — destination details card, Cancel a refund — response body — destination details crypto, Cancel a refund — response body — destination details paypal

Cancel a refund — response body — destination details blik

Field	Type	Presence	Description and constraints
`$`	object	Root
`network_decline_code`	JSON	Optional
`network_decline_code (anyOf 1)`	string	Alternative	For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. Maximum length: 5000
`network_decline_code (anyOf 2)`	null	Alternative
`reference`	JSON	Optional
`reference (anyOf 1)`	string	Alternative	The reference assigned to the refund. Maximum length: 5000
`reference (anyOf 2)`	null	Alternative
`reference_status`	JSON	Optional
`reference_status (anyOf 1)`	string	Alternative	Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. Maximum length: 5000
`reference_status (anyOf 2)`	null	Alternative

Cancel a refund — response body — destination details card

Field	Type	Presence	Description and constraints
`$`	object	Root
`reference`	string	Optional	Value of the reference number assigned to the refund. Maximum length: 5000
`reference_status`	string	Optional	Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`. Maximum length: 5000
`reference_type`	string	Optional	Type of the reference number assigned to the refund. Maximum length: 5000
`type`	string	Required within parent	The type of refund. This can be `refund`, `reversal`, or `pending`. Known values: pending, refund, reversal

Cancel a refund — response body — destination details crypto

Field	Type	Presence	Description and constraints
`$`	object	Root
`reference`	JSON	Optional
`reference (anyOf 1)`	string	Alternative	The transaction hash of the refund. Maximum length: 5000
`reference (anyOf 2)`	null	Alternative

Cancel a refund — response body — destination details p24

Field	Type	Presence	Description and constraints
`$`	object	Root
`reference`	JSON	Optional
`reference (anyOf 1)`	string	Alternative	The reference assigned to the refund. Maximum length: 5000
`reference (anyOf 2)`	null	Alternative
`reference_status`	JSON	Optional
`reference_status (anyOf 1)`	string	Alternative	Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. Maximum length: 5000
`reference_status (anyOf 2)`	null	Alternative

Cancel a refund — response body — destination details paypal

Field	Type	Presence	Description and constraints
`$`	object	Root
`network_decline_code`	JSON	Optional
`network_decline_code (anyOf 1)`	string	Alternative	For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. Maximum length: 5000
`network_decline_code (anyOf 2)`	null	Alternative

Cancel a refund — response body — next action

Field	Type	Presence	Description and constraints
`$`	object	Root
`display_details`	Model	Optional	Expand Cancel a refund — response body — next action display details
`type`	string	Required within parent	Type of the next action to perform. Maximum length: 5000

Referenced models: Cancel a refund — response body — next action display details

Cancel a refund — response body — next action display details

Field	Type	Presence	Description and constraints
`$`	object	Root
`email_sent`	Model	Required within parent	Expand Cancel a refund — response body — next action display details email sent
`expires_at`	JSON	Required within parent
`expires_at (anyOf 1)`	integer	Alternative	The expiry timestamp. Format: unix-time
`expires_at (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Cancel a refund — response body — next action display details email sent

Cancel a refund — response body — next action display details email sent

Field	Type	Presence	Description and constraints
`$`	object	Root
`email_sent_at`	JSON	Required within parent
`email_sent_at (anyOf 1)`	integer	Alternative	The timestamp when the email was sent. Format: unix-time
`email_sent_at (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`email_sent_to`	string	Required within parent	The recipient's email address. Maximum length: 5000

Cancel a refund — response body — presentment details

Field	Type	Presence	Description and constraints
`$`	object	Root
`presentment_amount`	JSON	Required within parent
`presentment_amount (anyOf 1)`	integer	Alternative	Amount intended to be collected by this payment, denominated in `presentment_currency`.
`presentment_amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`presentment_currency`	string	Required within parent	Currency presented to the customer during payment. Maximum length: 5000

Report an issue with this page