Sign in

v1

latestOpenAPI 3.1.02026-07-262343124.1 KB
Payments

Create a new payment

Creates a new payment with the provided payment details.

post/v1/payments

Headers

Api-Keystring required
Merchant-Idstring required
WCP-Versionstring nullable
Sdk-Namestring nullable
Sdk-Versionstring nullable
Sdk-Platformstring nullable
Idempotency-Keystring nullable

Request body

expiresAtinteger nullable
referenceIdstring required

Example request

{
  "amount": {
    "unit": "iso4217/USD",
    "value": "100"
  },
  "expiresAt": null,
  "referenceId": "ORDER-123"
}

Response

Payment created successfully

expiresAtinteger required

Payment expiration timestamp, in seconds since epoch

gatewayUrlstring required

Gateway URL to redirect the user to for payment

isFinalboolean required

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

paymentIdstring required

Payment ID

pollInMsinteger nullable

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

status'requires_action' | 'processing' | 'succeeded' | 'failed' | 'expired' | 'cancelled' required

Payment status representing the lifecycle of a payment.

Payments progress through these states from creation to terminal status. Some states are specific to the payment source (pull vs push).

Example response

{
  "expiresAt": 1718236800,
  "gatewayUrl": "https://api.pay.walletconnect.com/pay_123",
  "isFinal": false,
  "paymentId": "pay_fea2ecc101KQFN7X7QP87PNA9SVQNAQAFP",
  "pollInMs": 1000,
  "status": "requires_action"
}