Skip to main content
POST
/
v1
/
gateway
/
payment
/
{id}
/
options
Get payment options
curl --request POST \
  --url https://api.pay.walletconnect.com/v1/gateway/payment/{id}/options \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accounts": [
    "<string>"
  ],
  "refresh": [
    "<string>"
  ]
}
'
{
  "options": [
    {
      "actions": [
        {
          "data": {
            "chain_id": "<string>",
            "method": "<string>",
            "params": [
              "<unknown>"
            ]
          },
          "type": "walletRpc"
        }
      ],
      "amount": {
        "display": {
          "assetName": "<string>",
          "assetSymbol": "<string>",
          "decimals": 1,
          "iconUrl": "<string>",
          "networkIconUrl": "<string>",
          "networkName": "<string>"
        },
        "unit": "<string>",
        "value": "<string>"
      },
      "etaS": 1,
      "id": "<string>",
      "account": "<string>",
      "collectData": {
        "url": "<string>",
        "schema": {},
        "fields": [
          {
            "id": "<string>",
            "name": "<string>",
            "required": true,
            "type": "text"
          }
        ]
      }
    }
  ],
  "collectData": {
    "url": "<string>",
    "schema": {},
    "fields": [
      {
        "id": "<string>",
        "name": "<string>",
        "required": true,
        "type": "text"
      }
    ]
  },
  "info": {
    "amount": {
      "display": {
        "assetName": "<string>",
        "assetSymbol": "<string>",
        "decimals": 1,
        "iconUrl": "<string>",
        "networkIconUrl": "<string>",
        "networkName": "<string>"
      },
      "unit": "<string>",
      "value": "<string>"
    },
    "expiresAt": 1,
    "merchant": {
      "name": "<string>",
      "iconUrl": "<string>"
    },
    "status": "requires_action",
    "buyer": {
      "accountCaip10": "<string>",
      "accountProviderName": "<string>",
      "accountProviderIcon": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://walletconnect-pay-docs-tomiir-buyer-checkout-docs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Api-Key
string
header
required

Headers

​
Api-Key
string
required
​
App-Id
string

Path Parameters

​
id
string
required

Payment ID

Query Parameters

​
includePaymentInfo
boolean | null

Whether to include payment information in the response

Body

application/json
​
accounts
string[]
required
​
refresh
string[] | null

Response

Payment options retrieved successfully

​
options
object[]
required
​
collectData
object
​
info
object