Capture Payment
Captures the full amount of a card payment created with capture: false. The payment must still be in requires_capture before capture_expires_at. Partial capture, multiple captures, capturing more than the authorized amount, and tips are not supported.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-10-06"
Path Parameters
The unique identifier of the payment.
Response
Payment captured
The account receiving this payment, or null when the payment has no associated account.
When Whop will capture this authorization automatically, as an ISO 8601 timestamp. null when no automatic capture was requested.
null
When the card authorization must be captured, as an ISO 8601 timestamp. null when this payment was not authorized for later capture.
"2026-01-01T12:00:00.000Z"
The payment this status describes, prefixed pay_.
"pay_xxxxxxxxxxxxxx"
Details of the most recent failed attempt, or null when the payment has not failed.
What the buyer must do next while status is requires_action, otherwise null. type picks the shape and each variant carries only its own data, so switching on type gives you exactly that step's payload. The collect_card_present step is served only to a credential holding payment:charge on the account; any other reader sees null while the tap is outstanding.
- Redirect
- Display instructions
- Await confirmation
- Collect card present
Always payment_status.
"payment_status"
Present while status is processing on a settlement rail, otherwise null. A processing status without it has not been decided yet — keep polling.
Where to send the buyer once the payment reaches a resting state, or null to leave them where they are. Editable until they return — see the return_url operation.
"https://shinetime.example/checkout/done"
How far the payment has got. requires_confirmation — nothing attempted yet, or the last attempt failed and can be retried. requires_action — the buyer has a step outstanding; see next_action. requires_capture — the card authorization is holding funds and must be captured. confirming — the buyer has done their part and the processor is deciding. processing — with processing_details, the money is moving; without them, the charge is still being decided and the status should be read again. succeeded — collected. canceled — voided or written off.
requires_confirmation, requires_action, requires_capture, confirming, processing, succeeded, canceled "succeeded"

