Skip to main content
POST
Refresh Payment option
Replaces an expired or failed provider option with a newly quoted option. Refresh is rejected after any payment evidence is observed. Send a new Idempotency-Key for each intended replacement.

Authorizations

Authorization
string
header
required

Short-lived browser capability for exactly one payment_* resource. Never place it in a URL.

Headers

Idempotency-Key
string
required

Use this for retry-safe payment operations from your backend.

Example:

"payment-request-001"

Path Parameters

paymentId
string
required

Canonical payment_* identifier. Internal execution identifiers are never accepted by Partner Payment routes.

Pattern: ^payment_[A-Za-z0-9_-]+$
Example:

"payment_123"

optionId
string
required

Payment option returned by the payment-method selection endpoint.

Example:

"pay_option_123"

Body

application/json
receiptEmail
string<email>
Maximum string length: 254
fiatCurrency
string
Pattern: ^[A-Z]{3}$
Example:

"USD"

returnUrl
string<uri>
Maximum string length: 2048

Response

Replacement payment option

previousSelectedOptionId
string | null
required
Example:

"pay_option_previous"

option
object
required