Skip to main content
POST
Capture payment

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key
string

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

Maximum string length: 255
Example:

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

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-25-2"

Path Parameters

id
string
required

The unique identifier of the payment.

Response

Payment captured

capture_expires_at
string | null
required

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

Example:

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

id
string
required

The payment this status describes, prefixed pay_.

Example:

"pay_xxxxxxxxxxxxxx"

last_payment_error
object | null
required

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

next_action
Redirect · object
required

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.

object
string
required

Always payment_status.

Example:

"payment_status"

processing_details
object | null
required

Present while status is processing on a settlement rail, otherwise null.

return_url
string | null
required

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.

Example:

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

status
enum<string>
required

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 — the money is moving; see processing_details. succeeded — collected. canceled — voided or written off.

Available options:
requires_confirmation,
requires_action,
requires_capture,
confirming,
processing,
succeeded,
canceled
Example:

"requires_action"