Retrieve Payment Status
Retrieves how far a payment has got and what the buyer must do next, if anything. A payment is collected in the background, so poll this rather than reading the create response. Accepts either a secret key or the payment’s own client_secret, so the surface collecting the payment can poll it directly.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Path Parameters
The unique identifier of the payment.
Response
Payment status retrieved
The account receiving this payment, or null when the payment has no associated account.
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.
- Redirect
- Display instructions
- Await confirmation
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"

