{ "opencollection": "1.0.0", "info": { "name": "Stripe Accounts Account Charges API", "version": "2023-10-16" }, "items": [ { "info": { "name": "Charges", "type": "folder" }, "items": [ { "info": { "name": "GetCharges", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/charges", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "customer", "value": "", "type": "query", "description": "Only return charges for the customer specified by this customer ID." }, { "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 charges that were created by the PaymentIntent specified by this PaymentIntent 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." }, { "name": "transfer_group", "value": "", "type": "query", "description": "Only return charges for this transfer group." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

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

Use the Payment Intents API to initiate a new payment instead\nof using this method. Confirmation of the PaymentIntent creates the Charge\nobject used to request payment, so this method is limited to legacy integrations.

" }, { "info": { "name": "GetChargesSearch", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/charges/search", "params": [ { "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": "page", "value": "", "type": "query", "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results." }, { "name": "query", "value": "", "type": "query", "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges)." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Search for charges you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

" }, { "info": { "name": "GetChargesCharge", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/charges/:charge", "params": [ { "name": "charge", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

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

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

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

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

\n\n

Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.

\n\n

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

" }, { "info": { "name": "GetChargesChargeDispute", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/charges/:charge/dispute", "params": [ { "name": "charge", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieve a dispute for a specified charge.

" }, { "info": { "name": "PostChargesChargeDispute", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/charges/:charge/dispute", "params": [ { "name": "charge", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } } }, { "info": { "name": "PostChargesChargeDisputeClose", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/charges/:charge/dispute/close", "params": [ { "name": "charge", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } } }, { "info": { "name": "PostChargesChargeRefund", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/charges/:charge/refund", "params": [ { "name": "charge", "value": "", "type": "path", "description": "The identifier of the charge to refund." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

When you create a new refund, you must specify either a Charge or a PaymentIntent object.

\n\n

This action refunds a previously created charge that’s not refunded yet.\nFunds are refunded to the credit or debit card that’s originally charged.

\n\n

You can optionally refund only part of a charge.\nYou can repeat this until the entire charge is refunded.

\n\n

After you entirely refund a charge, you can’t refund it again.\nThis method raises an error when it’s called on an already-refunded" }, { "info": { "name": "GetChargesChargeRefunds", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/charges/:charge/refunds", "params": [ { "name": "charge", "value": "", "type": "path" }, { "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": "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 charge. Note that the 10 most recent refunds are always available by default on the charge 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.

" }, { "info": { "name": "PostChargesChargeRefunds", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/charges/:charge/refunds", "params": [ { "name": "charge", "value": "", "type": "path", "description": "The identifier of the charge to refund." } ], "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": "GetChargesChargeRefundsRefund", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/charges/:charge/refunds/:refund", "params": [ { "name": "charge", "value": "", "type": "path" }, { "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": "PostChargesChargeRefundsRefund", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/charges/:charge/refunds/:refund", "params": [ { "name": "charge", "value": "", "type": "path" }, { "name": "refund", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Update a specified refund.

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