POST /v1/test_helpers/issuing/authorizations/{authorization}/capture
Capture a test-mode authorization.
Servers
- https://api.stripe.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
authorization |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
close_authorization |
Boolean | No |
Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
capture_amount |
Integer | No |
The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the smallest currency unit. |
purchase_details |
Object | No |
Additional purchase information that is optionally provided by the merchant. |
purchase_details.flight |
Object | No | |
purchase_details.flight.travel_agency |
String | No | |
purchase_details.flight.departure_at |
Integer | No | |
purchase_details.flight.passenger_name |
String | No | |
purchase_details.flight.segments[] |
Array | No | |
purchase_details.flight.segments[].service_class |
String | No | |
purchase_details.flight.segments[].flight_number |
String | No | |
purchase_details.flight.segments[].stopover_allowed |
Boolean | No | |
purchase_details.flight.segments[].arrival_airport_code |
String | No | |
purchase_details.flight.segments[].departure_airport_code |
String | No | |
purchase_details.flight.segments[].carrier |
String | No | |
purchase_details.flight.refundable |
Boolean | No | |
purchase_details.fuel |
Object | No | |
purchase_details.fuel.industry_product_code |
String | No | |
purchase_details.fuel.type |
String | No |
Possible values:
|
purchase_details.fuel.unit_cost_decimal |
String | No | |
purchase_details.fuel.quantity_decimal |
String | No | |
purchase_details.fuel.unit |
String | No |
Possible values:
|
purchase_details.reference |
String | No | |
purchase_details.fleet |
Object | No | |
purchase_details.fleet.purchase_type |
String | No |
Possible values:
|
purchase_details.fleet.cardholder_prompt_data |
Object | No | |
purchase_details.fleet.cardholder_prompt_data.unspecified_id |
String | No | |
purchase_details.fleet.cardholder_prompt_data.driver_id |
String | No | |
purchase_details.fleet.cardholder_prompt_data.vehicle_number |
String | No | |
purchase_details.fleet.cardholder_prompt_data.user_id |
String | No | |
purchase_details.fleet.cardholder_prompt_data.odometer |
Integer | No | |
purchase_details.fleet.reported_breakdown |
Object | No | |
purchase_details.fleet.reported_breakdown.tax |
Object | No | |
purchase_details.fleet.reported_breakdown.tax.local_amount_decimal |
String | No | |
purchase_details.fleet.reported_breakdown.tax.national_amount_decimal |
String | No | |
purchase_details.fleet.reported_breakdown.non_fuel |
Object | No | |
purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal |
String | No | |
purchase_details.fleet.reported_breakdown.fuel |
Object | No | |
purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal |
String | No | |
purchase_details.fleet.service_type |
String | No |
Possible values:
|
purchase_details.lodging |
Object | No | |
purchase_details.lodging.check_in_at |
Integer | No | |
purchase_details.lodging.nights |
Integer | No | |
purchase_details.receipt[] |
Array | No | |
purchase_details.receipt[].description |
String | No | |
purchase_details.receipt[].quantity |
String | No | |
purchase_details.receipt[].unit_cost |
Integer | No | |
purchase_details.receipt[].total |
Integer | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.