決済リンクを作成
/events/:eventId/tickets/:ticketId/payment-link有料チケットの Stripe 決済リンクを作成します。返された url にユーザーを遷移させ、決済完了後に Webhook 経由で参加登録が確定します。successUrl / cancelUrl で決済後の戻り先を自サイトに指定できます。
| 認証 | 要ログイン |
|---|
パスパラメータ
eventIdstring必須イベント ID または slug。
ticketIdstring必須チケット種別 ID。チケットが設定されているイベントでは必須。
リクエストボディ
quantitynumber任意購入枚数(既定 1)。eventEntryId を指定する場合は 1 のみ。
invitationCodestring任意リファラルコード。8 文字ちょうど。割引は金額に反映される。
eventEntryIdstring任意承認後決済フロー用。主催者の承認後、状態が AWAITING_PAYMENT の自分の参加登録 ID を指定する。
successUrlstring任意決済完了後に戻るリダイレクト先 URL。省略すると 4S のチケット購入完了ページに戻ります。https(ローカル開発のみ http)の絶対 URL・フラグメント(#...)不可・2048 文字以内で、OAuth クライアントに登録済みの redirect URI と同じオリジンである必要があります。
cancelUrlstring任意決済をキャンセルしたときに戻るリダイレクト先 URL。省略すると Stripe の Checkout 画面に留まります。形式・オリジンの条件は successUrl と同じです。
補足
successUrl に指定した URL には、リダイレクトの際に Stripe Checkout セッション ID が session_id クエリパラメータ(例: ?session_id=cs_test_...)として付加されます。指定した URL に元々含まれているクエリパラメータはそのまま保持され、既に session_id を含む場合は付加されません。
cancelUrl にはクエリパラメータは付加されず、指定した URL にそのまま戻ります。どの購入のキャンセルかを判別したい場合は、あらかじめ自前のクエリパラメータ(例: ?orderId=...)を含めた URL を指定してください。
successUrl への到達は決済完了の保証ではありません。参加登録の確定は Stripe の Webhook で行われるため、戻ってきた session_id をレスポンスの sessionId と突き合わせたうえで、参加登録の状態は API で確認してください。
successUrl / cancelUrl が URL 形式として不正な場合、または登録済み redirect URI と異なるオリジンの場合は 400 を返します(それぞれ errorCode 10020 / 60002)。
レスポンス
| フィールド | 型 | 説明 |
|---|---|---|
url | string | Stripe Checkout の URL。 |
sessionId | string | Stripe Checkout セッション ID。 |
curl https://api.4s.link/events/EVENT_ID/tickets/TICKET_ID/payment-link \-X POST \-H "Authorization: Bearer 4s_at_..." \-H "Content-Type: application/json" \-d '{"quantity": 1,"successUrl": "https://example.com/tickets/complete","cancelUrl": "https://example.com/tickets/canceled"}'
{"url": "https://checkout.stripe.com/c/pay/cs_test_...","sessionId": "cs_test_..."}