{ "opencollection": "1.0.0", "info": { "name": "Stripe Accounts Account Refunds API", "version": "2023-10-16" }, "items": [ { "info": { "name": "Refunds", "type": "folder" }, "items": [ { "info": { "name": "GetRefunds", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/refunds", "params": [ { "name": "charge", "value": "", "type": "query", "description": "Only return refunds for the charge specified by this charge ID." }, { "name": "created", "value": "", "type": "query" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "payment_intent", "value": "", "type": "query", "description": "Only return refunds for the PaymentIntent specified by this ID." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first The 10 most recent refunds are always available by default on the Charge object.

" }, { "info": { "name": "PostRefunds", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/refunds", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

\n\n

Creating a new refund will refund a charge that has previously been created but not yet refunded.\nFunds will be refunded to the credit or debit card that was originally charged.

\n\n

You can optionally refund only part of a charge.\nYou can do so multiple times, until the entire charge has been refunded.

\n\n

Once entirely refunded, a charge can’t be refunded again.\nThis metho" }, { "info": { "name": "GetRefundsRefund", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/refunds/:refund", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "refund", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the details of an existing refund.

" }, { "info": { "name": "PostRefundsRefund", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/refunds/:refund", "params": [ { "name": "refund", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

\n\n

This request only accepts metadata as an argument.

" }, { "info": { "name": "PostRefundsRefundCancel", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/refunds/:refund/cancel", "params": [ { "name": "refund", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Cancels a refund with a status of requires_action.

\n\n

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

" }, { "info": { "name": "Stripe List Application Fee Refunds", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/application_fees/:id/refunds", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

" } ] } ], "bundled": true }