4.6 KiB
4.6 KiB
name, description
| name | description |
|---|---|
| charges-routes | Handle 14 OpenAPI operation(s) under /v1/charges for the charges route group. |
charges API Routes
Handle 14 OpenAPI operation(s) under /v1/charges for the charges route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
get_charges
- Operation ID:
get_charges - Route:
GET /v1/charges - Mode: READ
- Summary: List all charges
- Parameters:
createdinquerycustomerinqueryending_beforeinqueryexpandinquerylimitinquerypayment_intentinquerystarting_afterinquerytransfer_groupinquery
- Body: JSON request body accepted.
post_charges
- Operation ID:
post_charges - Route:
POST /v1/charges - Mode: WRITE
- Summary:
This method is no longer recommended—use the Payment Intents API to initiate a new payment instead. Confirmation of the PaymentIntent creates the
Chargeobject used to request payment. - Body: JSON request body accepted.
get_charges_search
- Operation ID:
get_charges_search - Route:
GET /v1/charges/search - Mode: READ
- Summary: Search charges
- Parameters:
expandinquerylimitinquerypageinqueryqueryinqueryrequired
- Body: JSON request body accepted.
get_charges_charge
- Operation ID:
get_charges_charge - Route:
GET /v1/charges/{charge} - Mode: READ
- Summary: Retrieve a charge
- Parameters:
chargeinpathrequiredexpandinquery
- Body: JSON request body accepted.
post_charges_charge
- Operation ID:
post_charges_charge - Route:
POST /v1/charges/{charge} - Mode: WRITE
- Summary: Update a charge
- Parameters:
chargeinpathrequired
- Body: JSON request body accepted.
post_charges_charge_capture
- Operation ID:
post_charges_charge_capture - Route:
POST /v1/charges/{charge}/capture - Mode: WRITE
- Summary: Capture a payment
- Parameters:
chargeinpathrequired
- Body: JSON request body accepted.
get_charges_charge_dispute
- Operation ID:
get_charges_charge_dispute - Route:
GET /v1/charges/{charge}/dispute - Mode: READ
- Summary:
Retrieve a dispute for a specified charge.
- Parameters:
chargeinpathrequiredexpandinquery
- Body: JSON request body accepted.
post_charges_charge_dispute
- Operation ID:
post_charges_charge_dispute - Route:
POST /v1/charges/{charge}/dispute - Mode: WRITE
- Summary: PostChargesChargeDispute
- Parameters:
chargeinpathrequired
- Body: JSON request body accepted.
post_charges_charge_dispute_close
- Operation ID:
post_charges_charge_dispute_close - Route:
POST /v1/charges/{charge}/dispute/close - Mode: WRITE
- Summary: PostChargesChargeDisputeClose
- Parameters:
chargeinpathrequired
- Body: JSON request body accepted.
post_charges_charge_refund
- Operation ID:
post_charges_charge_refund - Route:
POST /v1/charges/{charge}/refund - Mode: WRITE
- Summary: Create a refund
- Parameters:
chargeinpathrequired
- Body: JSON request body accepted.
get_charges_charge_refunds
- Operation ID:
get_charges_charge_refunds - Route:
GET /v1/charges/{charge}/refunds - Mode: READ
- Summary: List all refunds
- Parameters:
chargeinpathrequiredending_beforeinqueryexpandinquerylimitinquerystarting_afterinquery
- Body: JSON request body accepted.
post_charges_charge_refunds
- Operation ID:
post_charges_charge_refunds - Route:
POST /v1/charges/{charge}/refunds - Mode: WRITE
- Summary: Create customer balance refund
- Parameters:
chargeinpathrequired
- Body: JSON request body accepted.
get_charges_charge_refunds_refund
- Operation ID:
get_charges_charge_refunds_refund - Route:
GET /v1/charges/{charge}/refunds/{refund} - Mode: READ
- Summary:
Retrieves the details of an existing refund.
- Parameters:
chargeinpathrequiredexpandinqueryrefundinpathrequired
- Body: JSON request body accepted.
post_charges_charge_refunds_refund
- Operation ID:
post_charges_charge_refunds_refund - Route:
POST /v1/charges/{charge}/refunds/{refund} - Mode: WRITE
- Summary:
Update a specified refund.
- Parameters:
chargeinpathrequiredrefundinpathrequired
- Body: JSON request body accepted.