Skip to main content
POST
Confirm a payment

Authorizations

Api-Key
string
header
required

Headers

Api-Key
string | null
App-Id
string | null
Client-Id
string | null
WCP-Version
string | null
Sdk-Name
string | null
Sdk-Version
string | null
Sdk-Platform
string | null

Path Parameters

id
string
required

Payment ID

Example:

"pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV"

Query Parameters

maxPollMs
integer<int64> | null

Maximum time to long-poll for payment status, in milliseconds.

Required range: x >= 0

Body

application/json
optionId
string
required

ID of the option to confirm

results
object[]
required
collectedData
null | object
Example:

Response

Payment confirmed successfully

isFinal
boolean
required

True if the payment is in a final state and no longer requires polling

status
enum<string>
required

Payment status

Available options:
requires_action,
processing,
succeeded,
failed,
expired,
cancelled
info
null | object

Payment information (transaction hash). Present when status is Succeeded, null otherwise.

pollInMs
integer<int64> | null

Time to poll for payment status, in milliseconds. Not present if the payment is in a final state.

Required range: x >= 0