API Reference2026-02-19.previewGateway

Confirm a payment

POST
/v1/gateway/payment/{id}/confirm

Authorization

headerApi-Key<token>

Path Parameters

id*string

Payment ID

Query Parameters

maxPollMs?|

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

Formatint64
Range0 <= value

Header Parameters

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

Request Body

application/json
  1. body
collectedData?null|
optionId*string

ID of the option to confirm

results*array<>

Response Body

Payment confirmed successfully

application/json
  1. response
info?null|
isFinal*boolean

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

pollInMs?|

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

Formatint64
Range0 <= value
status*PaymentStatus

Payment status

Value in"requires_action""processing""succeeded""failed""expired""cancelled"
curl -X POST 'https://api.pay.walletconnect.com/v1/gateway/payment/pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV/confirm' \  -H 'Content-Type: application/json' \  -d '{  "optionId": "string",  "results": [    {      "data": [        null      ],      "type": "walletRpc"    }  ]}'
{  "info": null,  "isFinal": true,  "pollInMs": 0,  "status": "requires_action"}