API reference

Get Supported Info#

Query the list of schemes, networks, and signers supported by the Facilitator. The Seller SDK calls this endpoint to build the accepts array for the 402 response.

Request URL#

GET /api/v6/pay/x402/supported

Request Parameters: None

Response Parameters#

ParameterTypeDescription
kindsArray<SupportedKind>List of supported payment types
kinds[].x402VersionIntegerx402 protocol version, e.g. 2
kinds[].schemeStringSettlement scheme: exact (one-time payment with a fixed amount) / aggr_deferred (deferred aggregated settlement)
kinds[].networkStringCAIP-2 chain identifier, e.g. eip155:196 (X Layer)
kinds[].extraObjectScheme-specific extended configuration (optional)
extensionsArray<String>List of supported extension identifiers
signersObjectCAIP-2 wildcard to signer address array mapping

Request Example#

Bash
curl --location --request GET 'https://web3.okx.com/api/v6/pay/x402/supported' \
--header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \
--header 'OK-ACCESS-SIGN: leaV********3uw=' \
--header 'OK-ACCESS-PASSPHRASE: 1****6' \
--header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z'

Response Example#

Json
{
  "code": "0",
  "data": {
    "kinds": [
      {
        "x402Version": 2,
        "scheme": "exact",
        "network": "eip155:196",
        "extra": null
      },
      {
        "x402Version": 2,
        "scheme": "aggr_deferred",
        "network": "eip155:196",
        "extra": null
      }
    ],
    "extensions": [],
    "signers": {
      "eip155:*": ["0x...facilitatorSignerAddress"]
    }
  },
  "msg": ""
}
Table of contents