v1

latestOpenAPI 3.1.02026-07-262343124.1 KB

Payments

Get payment details

Retrieves the full details of a payment by its ID, including settlement information when available.

get/v1/payments/{id}

Path parameters

idstring required

Payment ID

Example:pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV

Payment ID

Headers

Api-Keystring required

Merchant-Idstring required

WCP-Versionstring nullable

Sdk-Namestring nullable

Sdk-Versionstring nullable

Sdk-Platformstring nullable

Idempotency-Keystring nullable

Response

Payment details retrieved successfully

failureCode'declined_user'

Machine-readable code identifying why a payment reached Failed.

Two distinct string forms exist per variant:

Strum (Display/AsRefStr/EnumString): the DynamoDB storage form written to the failure_reason column. Preserves the existing on-disk value for rows written before this type existed.
Serde (Serialize/Deserialize): the public API form. Deliberately decoupled from the internal term so that compliance-specific wording isn't surfaced to external consumers.

referenceIdstring required

Merchant-provided reference ID for this payment, as supplied during payment creation

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

{
  "info": {
    "optionAmount": {
      "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"
    },
    "txId": "0xabc123..."
  },
  "referenceId": "ORDER-123",
  "settlement": null,
  "status": "succeeded"
}