Skip to main content
POST
Resume a parked renewal

Autorizaciones

Authorization
string
header
requerido

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

member:payment_methods:use

Encabezados

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Ejemplo:

"d9105228-4a08-46b1-8b91-42fed586d383"

Parámetros de ruta

payment_id
string
requerido

The unique identifier of the payment.

Cuerpo

application/json
client_secret
string

The payment's own client_secret, for a buyer without a token.

return_url
string

Where the buyer continues after completing an off-site step. Must be an absolute https URL without credentials (http is allowed for localhost), at most 2,048 characters. Defaults to Whop's hosted verification page. Ignored when the payment is not waiting on authentication.

Ejemplo:

"https://shinetime.example/billing/recovered"

Respuesta

Resume requested

account
object | null
requerido

The account receiving this payment, or null when the payment has no associated account.

auto_capture_at
string | null
requerido

When Whop will capture this authorization automatically, as an ISO 8601 timestamp. null when no automatic capture was requested.

Ejemplo:

null

capture_expires_at
string | null
requerido

When the card authorization must be captured, as an ISO 8601 timestamp. null when this payment was not authorized for later capture.

Ejemplo:

"2026-01-01T12:00:00.000Z"

id
string
requerido

The payment this status describes, prefixed pay_.

Ejemplo:

"pay_xxxxxxxxxxxxxx"

last_payment_error
object | null
requerido

Details of the most recent failed attempt, or null when the payment has not failed.

next_action
Redirect · object
requerido

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.

object
string
requerido

Always payment_status.

Ejemplo:

"payment_status"

processing_details
object | null
requerido

Present while status is processing on a settlement rail, otherwise null. A processing status without it has not been decided yet — keep polling.

return_url
string | null
requerido

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.

Ejemplo:

"https://shinetime.example/checkout/done"

status
enum<string>
requerido

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.

Opciones disponibles:
requires_confirmation,
requires_action,
requires_capture,
confirming,
processing,
succeeded,
canceled
Ejemplo:

"succeeded"