Capture stripe Fee

POST

/api/fees/v2/:id/capture/stripe

This endpoint can only be used after setting up the billing integration. Refer to the billing integration documentation for more details.

This endpoint may return a 409 error response with one of these public message values:

Invalid Fee Status
Missing Customer
Missing Customer Payment Method
Payment Already Captured
Payment has been Voided

This endpoint can only be used after setting up the billing integration. Refer to the [billing integration documentation](/documentation/integrations/billing/overview) for more details. This endpoint may return a `409` error response with one of these public `message` values: - `Invalid Fee Status` - `Missing Customer` - `Missing Customer Payment Method` - `Payment Already Captured` - `Payment has been Voided`

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

idstringRequired

Response

This endpoint returns an object.

idstring

createdAtdatetime

patientIdstring

typeenum

amountinteger

statusenum

serviceIdstring

externalIdstring

stripeobject

1	{
2	"id": "id",
3	"createdAt": "2024-01-15T09:30:00Z",
4	"patientId": "patientId",
5	"type": "LATE_CANCELLATION",
6	"amount": 1,
7	"status": "PENDING",
8	"serviceId": "serviceId",
9	"externalId": "externalId",
10	"stripe": {
11	"status": "status",
12	"client_secret": "client_secret",
13	"last_payment_error": {
14	"key": "value"
15	},
16	"next_action": {
17	"key": "value"
18	}
19	}
20	}

$	curl -X POST https://app.usebridge.com/api/fees/v2/id/capture/stripe \
>	-H "X-API-Key: <apiKey>"