Skip to main content
PATCH
Update payment return URL

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 ***************************.

Path Parameters

payment_id
string
required

The unique identifier of the payment.

Body

application/json
return_url
string
required

Where the buyer continues after completing an off-site step. Must be an absolute https URL without credentials, at most 2,048 characters.

Example:

"https://merchant.example/thanks"

Response

Return URL updated

id
string
required

The payment this status describes, prefixed pay_.

last_payment_error
object | null
required

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

next_action
object | null
required

What the buyer must do next while status is requires_action, otherwise null.

object
string
required

Always 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.

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. 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,
confirming,
processing,
succeeded,
canceled
Example:

"requires_confirmation"