Skip to main content
PATCH
TypeScript

Autorisationer

Authorization
string
header
påkrævet

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.

Scopes

payment:setup_intent:manage

Sti-parametre

setup_intent_id
string
påkrævet

The unique identifier of the setup intent.

Krop

application/json
return_url
string
påkrævet

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.

Eksempel:

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

client_secret
string

The setup's own client_secret, for a caller without a secret key.

Svar

Return URL updated

id
string
påkrævet

The setup this status describes, prefixed sint_.

Eksempel:

"sint_xxxxxxxxxxxxxx"

last_setup_error
object | null
påkrævet

Why the setup ended where it did, or null when nothing has failed. Present on canceled — a buyer who abandoned carries no code, one refused by the provider does.

next_action
Redirect · object
påkrævet

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
påkrævet

Always setup_status.

Eksempel:

"setup_status"

return_url
string | null
påkrævet

Where to send the buyer once the setup reaches a resting state, or null to leave them where they are.

Eksempel:

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

status
enum<string>
påkrævet

How far the setup has got. A 200 means we answered, not that the method was saved — always branch on this. requires_action — the buyer has a step outstanding; see next_action. processing — the buyer has done their part and the processor is deciding. succeeded — the payment method is saved, and only this one means saved. canceled — abandoned or refused; see last_setup_error to tell which.

Tilgængelige muligheder:
processing,
succeeded,
canceled,
requires_action
Eksempel:

"canceled"