Sign in

v1

latestOpenAPI 3.1.02026-07-262343124.1 KB
Gateway

Get a payment

This endpoint returns only basic information to display to the user to begin the payment flow.

get/v1/gateway/payment/{id}

Path parameters

idstring required

Payment ID

Example:pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV

Payment ID

Headers

Api-Keystring nullable
App-Idstring nullable
Client-Idstring nullable
WCP-Versionstring nullable
Sdk-Namestring nullable
Sdk-Versionstring nullable
Sdk-Platformstring nullable

Response

Payment status retrieved successfully

expiresAtinteger required
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

{
  "amount": {
    "display": {
      "assetName": "USD Coin",
      "assetSymbol": "USDC",
      "decimals": 6,
      "iconUrl": "https://assets.walletconnect.com/usdc.png",
      "networkIconUrl": "https://assets.walletconnect.com/base.png",
      "networkName": "Base"
    },
    "unit": "caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000",
    "value": "1000000"
  },
  "buyer": {
    "accountCaip10": "eip155:1:0x0000000000000000000000000000000000000000",
    "accountProviderIcon": "https://example.com/icon.png",
    "accountProviderName": "Wallet"
  },
  "expiresAt": 1700000000,
  "merchant": {
    "iconUrl": "https://example.com/icon.png",
    "name": "Merchant"
  },
  "status": "requires_action"
}