Skip to content

Pay for an order​

POST
/event-orders/{id}/pay

Free: confirmed at once (requested when the hosts approve each reservation). Paid: a PaymentIntent on the platform account (no destination; metadata.kind = event_order, metadata.order_id; manual capture when approval is on, charged only when a host approves), and its client secret. The money is split into one ordinary gift per Fundly when the payment succeeds (the Stripe webhook). With the one sheet (#2581, while features.donate_sheet_v2 is on for the buyer) the body carries the way to pay: the order is priced with that method's fee, the PaymentIntent takes that method only and is confirmed by the server. A US bank debit that is processing issues the tickets at once and leaves the order clearing; a bank debit the bank returns later cancels the order. Bank is refused for an order the hosts approve and for an event less than 7 days away.

Authorizations​

or
BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Header Parameters

X-Order-Token

The order link's token, for a buyer without an account.

Type
string

Path Parameters

id*

The order's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"confirmation_token_id": "string",
"payment_method_id": "string",
"save_payment_method": true,
"save_consent_version": "string",
"expected_total_cents": 0,
"return_url": "string"
}

Responses​

The order, and the payment to confirm (null when free).

application/json
JSON
{
"order": "string",
"payment": {
"client_secret": "string",
"payment_intent_id": "string",
"amount_cents": 0,
"capture": "string",
"status": "string",
"stripe_fee_cents": 0,
"net_amount_cents": 0,
"fee_kind": "string"
}
}

Playground​

Server
Headers
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress