API 参考

HTTP 端 API - 单次支付#

本文档是单次支付的 API 参考,涵盖 exactcharge 两种 scheme 的完整接口定义。使用指南与 SDK 接入示例请参阅 单次支付 · 接入文档

exact 还是 charge#

exact 单收款方,同步 / 异步结算都支持。

charge 除了单收款方,还支持分账(Split),即单次支付多地址收款(≤10),默认且只支持同步结算。

维度exactcharge
收款方单收款方单收款方 / 单次支付多地址收款(≤10)
结算时序同步 / 异步均可默认且只支持同步
接入指南exact 路径charge 路径
  • Base URL:https://web3.okx.com
  • exact 路径前缀:/api/v6/pay/x402
  • charge 路径前缀:/api/v6/pay/mpp/charge
  • Network:X Layer(chainId 196,CAIP-2 标识 eip155:196

认证#

所有接口均需通过 API Key 认证,请求头中携带以下字段:

Header必传描述
OK-ACCESS-KEYAPI Key
OK-ACCESS-SIGN请求签名
OK-ACCESS-PASSPHRASEAPI 密码短语
OK-ACCESS-TIMESTAMPISO 8601 时间戳
Content-TypePOST 请求需设为 application/json

所有响应统一使用业务包络:

json
{
  "code": "0",
  "msg": "success",
  "data": { /* 业务字段 */ }
}

业务错误时 code 为非 "0"datanull,错误码集中见文末 错误码 章节。


exact Scheme#

1. /api/v6/pay/x402/supported#

GET
/api/v6/pay/x402/supported

查询 Broker 支持的 scheme、network 及签名者列表。Seller SDK 调用此接口构建 402 响应的 accepts 数组。

请求参数#

无。

响应参数#

参数类型描述
kindsArray<SupportedKind>支持的支付类型列表
kinds[].x402VersionInteger协议版本,如 2
kinds[].schemeString结算方案:exact / aggr_deferred
kinds[].networkStringCAIP-2 链标识,如 eip155:196
kinds[].extraObjectscheme 特有扩展配置
extensionsArray<String>支持的扩展标识列表
signersObjectCAIP-2 通配符 → 签名者地址数组映射

请求示例#

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'

响应示例#

json
{
  "code": "0",
  "msg": "",
  "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...brokerSignerAddress"]
    }
  }
}

2. /api/v6/pay/x402/verify#

POST
/api/v6/pay/x402/verify

校验 Buyer 签名的支付授权有效性,不执行链上交易

请求参数#

参数类型必传描述
x402VersionInteger协议版本,如 2
paymentPayloadObject客户端随受保护请求携带的 支付载荷,详见 PaymentPayload
paymentRequirementsObjectSeller 定义的支付要求,详见 PaymentRequirements

约束:paymentPayload.accepted.schemepaymentRequirements.scheme 必须均为 "exact"

响应参数#

参数类型描述
isValidBooleantrue 验证通过,false 验证失败
invalidReasonString机器可读的无效原因(验证失败时返回)
invalidMessageString人类可读的无效说明(验证失败时返回)
payerString付款方钱包地址

请求示例#

bash
curl --location --request POST 'https://web3.okx.com/api/v6/pay/x402/verify' \
--header 'Content-Type: application/json' \
--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' \
--data '{
  "x402Version": 2,
  "paymentPayload": {
    "x402Version": 2,
    "resource": {
      "url": "https://api.example.com/premium-data",
      "description": "Access to premium data",
      "mimeType": "application/json"
    },
    "accepted": {
      "scheme": "exact",
      "network": "eip155:196",
      "amount": "10000",
      "asset": "0x4ae46a509f6b1d9056937ba4500cb143933d2dc8",
      "payTo": "0xRecipientAddress",
      "maxTimeoutSeconds": 60,
      "extra": { "name": "USDG", "version": "2" }
    },
    "payload": {
      "signature": "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480...",
      "authorization": {
        "from": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
        "to": "0xRecipientAddress",
        "value": "10000",
        "validAfter": "0",
        "validBefore": "1740672154",
        "nonce": "0xf374661..."
      }
    }
  },
  "paymentRequirements": {
    "scheme": "exact",
    "network": "eip155:196",
    "amount": "10000",
    "asset": "0x4ae46a509f6b1d9056937ba4500cb143933d2dc8",
    "payTo": "0xRecipientAddress",
    "maxTimeoutSeconds": 60,
    "extra": { "name": "USDG", "version": "2" }
  }
}'

响应示例 — 验证通过#

json
{
  "code": "0",
  "msg": "success",
  "data": {
    "isValid": true,
    "invalidReason": null,
    "invalidMessage": null,
    "payer": "0xcb30ed083ad246b126a3aa1f414b44346e83e67d"
  }
}

响应示例 — 验证失败#

json
{
  "code": "0",
  "msg": "success",
  "data": {
    "isValid": false,
    "invalidReason": "insufficient_funds",
    "invalidMessage": "Payer balance is below required amount",
    "payer": "0xcb30ed083ad246b126a3aa1f414b44346e83e67d"
  }
}

3. /api/v6/pay/x402/settle#

POST
/api/v6/pay/x402/settle

验证通过后,提交链上结算。exact 模式每次调用都会发起一笔独立的 transferWithAuthorization 链上交易。

请求参数#

参数类型必传描述
x402VersionInteger协议版本,如 2
paymentPayloadObject同 verify
paymentRequirementsObject同 verify
syncSettleBooleanOKX 扩展true=同步等待链上确认;false(默认)=异步广播

响应参数#

参数类型描述
successBoolean结算是否成功
errorReasonString机器可读的失败原因(失败时返回)
errorMessageString人类可读的失败说明(失败时返回)
payerString付款方钱包地址
transactionString链上交易哈希
networkStringCAIP-2 链标识
statusStringOKX 扩展。结算状态,见下表

status 取值:

syncSettle结果statustransaction
false(默认)已广播pendingtxHash
true链上确认成功successtxHash
true等待超时timeouttxHash
验签 / 模拟 / 链上失败""""

请求示例#

bash
curl --location --request POST 'https://web3.okx.com/api/v6/pay/x402/settle' \
--header 'Content-Type: application/json' \
--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' \
--data '{
  "x402Version": 2,
  "paymentPayload": { "...同 verify..." },
  "paymentRequirements": { "...同 verify..." },
  "syncSettle": true
}'

响应示例 — 同步结算成功(syncSettle=true)#

json
{
  "code": "0",
  "msg": "success",
  "data": {
    "success": true,
    "errorReason": null,
    "errorMessage": null,
    "payer": "0xcb30ed083ad246b126a3aa1f414b44346e83e67d",
    "transaction": "0x4f46ed8eac92ddbccfb56a88ff827db3616c7beb191adabbeeded901340bd7d5",
    "network": "eip155:196",
    "status": "success"
  }
}

响应示例 — 异步结算(syncSettle=false)#

json
{
  "code": "0",
  "msg": "success",
  "data": {
    "success": true,
    "errorReason": null,
    "errorMessage": null,
    "payer": "0xcb30ed083ad246b126a3aa1f414b44346e83e67d",
    "transaction": "0x4f46ed8eac92ddbccfb56a88ff827db3616c7beb191adabbeeded901340bd7d5",
    "network": "eip155:196",
    "status": "pending"
  }
}

响应示例 — 结算失败#

json
{
  "code": "0",
  "msg": "success",
  "data": {
    "success": false,
    "errorReason": "insufficient_funds",
    "errorMessage": "Transaction reverted",
    "payer": "0xcb30ed083ad246b126a3aa1f414b44346e83e67d",
    "transaction": "",
    "network": "eip155:196",
    "status": ""
  }
}

4. /api/v6/pay/x402/settle/status#

GET
/api/v6/pay/x402/settle/status

根据链上交易哈希查询结算状态,适用于 syncSettle=false 异步结算的轮询场景。

请求参数#

参数位置类型必传描述
txHashqueryString链上交易哈希

响应参数#

参数类型描述
successBoolean查询是否成功(txHash 不存在时为 false
errorReasonString机器可读的失败原因
errorMessageString人类可读的失败说明
payerString付款方钱包地址
transactionString链上交易哈希
networkStringCAIP-2 链标识
statusString当前结算状态:pending / success / failed

请求示例#

bash
curl --location --request GET 'https://web3.okx.com/api/v6/pay/x402/settle/status?txHash=0x4f46ed8eac92ddbccfb56a88ff827db3616c7beb191adabbeeded901340bd7d5' \
--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'

响应示例 — 查询成功#

json
{
  "code": "0",
  "msg": "success",
  "data": {
    "success": true,
    "errorReason": null,
    "errorMessage": null,
    "payer": "0xcb30ed083ad246b126a3aa1f414b44346e83e67d",
    "transaction": "0x4f46ed8eac92ddbccfb56a88ff827db3616c7beb191adabbeeded901340bd7d5",
    "network": "eip155:196",
    "status": "success"
  }
}

响应示例 — 交易未找到#

json
{
  "code": "0",
  "msg": "success",
  "data": {
    "success": false,
    "errorReason": "not_found",
    "errorMessage": "Transaction not found for txHash: 0xabc123...",
    "payer": null,
    "transaction": null,
    "network": null,
    "status": null
  }
}

charge Scheme#

charge 基于 HTTP 402 Challenge-Credential 流程提供一次性代币转账能力。

  • 服务端代付(transaction 模式):Buyer 签署 EIP-3009 授权,Broker 代为提交链上交易
  • 客户端自付(hash 模式):Buyer 自行广播链上交易,Broker 验证交易有效性

5. /api/v6/pay/mpp/charge/settle#

POST
/api/v6/pay/mpp/charge/settle

服务端代付 — 代替用户提交链上 ERC-20 转账。支持 EIP-3009 授权方式,支持分账(最多 10 笔)。

请求参数#

参数类型必传描述
challengeObject服务端签发的 Challenge 对象(原样回传),详见 Challenge
payloadObjectEVM 支付凭证
payload.typeString固定 "transaction"
payload.authorizationObjectEIP-3009 授权对象
payload.authorization.typeString固定 "eip-3009"
payload.authorization.fromString付款方钱包地址
payload.authorization.toString收款方钱包地址
payload.authorization.valueString支付金额(base units)
payload.authorization.validAfterString授权生效 Unix 时间戳
payload.authorization.validBeforeString授权过期 Unix 时间戳
payload.authorization.nonceString随机 bytes32,每笔授权唯一
payload.authorization.signatureString65 字节 EIP-712 签名(r‖s‖v)
payload.authorization.splitsArray分账列表,最多 10 条,详见 Split
sourceString付款方 DID(did:pkh:eip155:196:0x...

响应参数#

参数类型描述
methodString固定值 "evm"
referenceString链上交易哈希(0x 前缀)
statusString固定值 "success"
timestampStringRFC 3339 结算时间
chainIdInteger结算所在链 ID,如 196
challengeIdStringChallenge ID,用于客户端关联
externalIdString原样回传自 Challenge request 的商户订单号

请求示例#

bash
curl --location --request POST 'https://web3.okx.com/api/v6/pay/mpp/charge/settle' \
--header 'Content-Type: application/json' \
--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' \
--data '{
  "challenge": {
    "id": "qB3wErTyU7iOpAsD9fGhJk",
    "realm": "api.example.com",
    "method": "evm",
    "intent": "charge",
    "request": "eyJhbW91bnQiOiIxMDAwMCIsImN1cnJlbmN5Ijoi...",
    "expires": "2026-04-01T12:05:00Z"
  },
  "payload": {
    "type": "transaction",
    "authorization": {
      "type": "eip-3009",
      "from": "0x1234567890abcdef1234567890abcdef12345678",
      "to": "0x742d35Cc6634c0532925a3b844bC9e7595F8fE00",
      "value": "10000",
      "validAfter": "0",
      "validBefore": "9999999999",
      "nonce": "0x9337d07c707c703b86f05e66b9097e38e7587e7ecfe740551ac608693864abdd",
      "signature": "0x5a9827232b5c640d7239462dbb3f0eede1aa2522eb53e552369db8db66720293..."
    }
  }
}'

响应示例#

json
{
  "code": "0",
  "msg": "",
  "data": {
    "method": "evm",
    "reference": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
    "status": "success",
    "timestamp": "2026-04-01T12:04:30Z",
    "chainId": 196,
    "challengeId": "qB3wErTyU7iOpAsD9fGhJk",
    "externalId": "order-12345"
  }
}

请求示例 — 含分账#

bash
curl --location --request POST 'https://web3.okx.com/api/v6/pay/mpp/charge/settle' \
--header 'Content-Type: application/json' \
--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' \
--data '{
  "challenge": {
    "id": "sP1itPaym3ntEx4mple",
    "realm": "marketplace.example.com",
    "method": "evm",
    "intent": "charge",
    "request": "eyJ...",
    "expires": "2026-04-01T12:05:00Z"
  },
  "payload": {
    "type": "transaction",
    "authorization": {
      "type": "eip-3009",
      "from": "0x1234567890abcdef1234567890abcdef12345678",
      "to": "0x742d35Cc6634c0532925a3b844bC9e7595F8fE00",
      "value": "940000",
      "validAfter": "0",
      "validBefore": "1775059500",
      "nonce": "0x1111111111111111111111111111111111111111111111111111111111111111",
      "signature": "0xabc...primary",
      "splits": [
        {
          "from": "0x1234567890abcdef1234567890abcdef12345678",
          "to": "0xA1B2C3d4e5F6a1B2c3d4e5F6a1b2c3d4e5F6a1b2",
          "value": "50000",
          "validAfter": "0",
          "validBefore": "1775059500",
          "nonce": "0x2222222222222222222222222222222222222222222222222222222222222222",
          "signature": "0xdef...split1"
        },
        {
          "from": "0x1234567890abcdef1234567890abcdef12345678",
          "to": "0xC4D5e6F7A8B9c4D5E6f7a8B9c4d5e6F7a8b9C4D5",
          "value": "10000",
          "validAfter": "0",
          "validBefore": "1775059500",
          "nonce": "0x3333333333333333333333333333333333333333333333333333333333333333",
          "signature": "0xghi...split2"
        }
      ]
    }
  },
  "source": "did:pkh:eip155:196:0x1234567890abcdef1234567890abcdef12345678"
}'

6. /api/v6/pay/mpp/charge/verifyHash#

POST
/api/v6/pay/mpp/charge/verifyHash

客户端自付 — 验证客户端已广播的链上交易,确认交易符合 Challenge 中的支付要求。

请求参数#

参数类型必传描述
challengeObject服务端签发的 Challenge 对象(原样回传),详见 Challenge
payloadObject支付凭证
payload.typeString固定 "hash"
payload.hashString客户端已广播的链上交易哈希
sourceString付款方 DID(did:pkh:eip155:196:0x...

响应参数#

参数类型描述
methodString固定值 "evm"
referenceString链上交易哈希(0x 前缀)
statusString固定值 "success"
timestampStringRFC 3339 确认时间
chainIdInteger链 ID,如 196
challengeIdStringChallenge ID,用于客户端关联
externalIdString原样回传自 Challenge request 的商户订单号

请求示例#

bash
curl --location --request POST 'https://web3.okx.com/api/v6/pay/mpp/charge/verifyHash' \
--header 'Content-Type: application/json' \
--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' \
--data '{
  "challenge": {
    "id": "qB3wErTyU7iOpAsD9fGhJk",
    "realm": "api.example.com",
    "method": "evm",
    "intent": "charge",
    "request": "eyJhbW91bnQiOiIxMDAwMCIsImN1cnJlbmN5Ijoi...",
    "expires": "2026-04-01T12:05:00Z"
  },
  "payload": {
    "type": "hash",
    "hash": "0xd9a703784f0cb489ea90c52f5626a22516f39c5063558733bb742972fdf6f722"
  },
  "source": "did:pkh:eip155:196:0x1234567890abcdef1234567890abcdef12345678"
}'

响应示例#

json
{
  "code": "0",
  "msg": "",
  "data": {
    "method": "evm",
    "reference": "0x9f8e7d6c5b4a3928170fabcdef1234567890abcdef1234567890abcdef123456",
    "status": "success",
    "timestamp": "2026-04-01T12:04:30Z",
    "chainId": 196,
    "challengeId": "qB3wErTyU7iOpAsD9fGhJk",
    "externalId": "order-12345"
  }
}

公共数据结构#

PaymentPayload#

Buyer 签名后通过 X-PAYMENT Header(base64 编码)传递给 Seller,Seller 原样透传给 Broker。

参数类型必传描述
x402VersionInteger协议版本,如 2
resourceObject受保护资源描述
resource.urlString受保护资源的 URL
resource.descriptionString资源描述
resource.mimeTypeString预期响应的 MIME 类型
acceptedObjectBuyer 选中的支付方式(从 accepts 数组中选取),结构同 PaymentRequirements
payloadObject签名数据
payload.signatureStringEIP-712 签名(EOA 签名)
payload.authorizationObjectEIP-3009 授权参数,详见 Authorization

PaymentRequirements#

同时用作 402 响应 accepts 数组元素和 paymentPayload.accepted

参数类型必传描述
schemeString固定 "exact"
networkStringCAIP-2 链标识,如 eip155:196
amountString支付金额(原子单位字符串)
assetString代币合约地址
payToString收款钱包地址
maxTimeoutSecondsInteger支付完成的最大超时时间(秒)
extraObjectscheme 特有扩展(如 name / version

Authorization#

参数类型必传描述
fromString付款方钱包地址(EOA)
toString收款方钱包地址(应等于 payTo
valueString支付金额(原子单位,应等于 amount
validAfterString授权生效的 Unix 时间戳
validBeforeString授权过期的 Unix 时间戳
nonceString32 字节随机 nonce(0x hex,防重放)

Challenge#

由服务端签发的 Challenge 对象,客户端原样回传。

参数类型必传描述
idStringChallenge ID
realmString保护空间标识
methodString固定 "evm"
intentString支付意图:"charge" / "session"
requestStringbase64url 编码的请求参数
expiresString过期时间(ISO 8601)

Split#

Charge 分账列表中的单条分账项,每笔需独立签名。

参数类型必传描述
fromString付款方地址(与主签名相同)
toString分账收款方地址
valueString分账金额(base units)
validAfterString授权生效 Unix 时间戳
validBeforeString授权过期 Unix 时间戳
nonceString独立 nonce(bytes32)
signatureString65 字节 EIP-712 签名

支持的网络和币种#

网络Chain Index状态
X Layer196已支持

X Layer 支持的稳定币:

币种合约地址
USDG0x4ae46a509f6b1d9056937ba4500cb143933d2dc8
USD₮00x779ded0c9e1022225f8e0630b35a9b54be713736

错误码#

错误响应统一使用包络 {"code": "<code>", "msg": "<message>", "data": null}

1. 认证错误(HTTP 401)#

错误码描述
50103请求头 OK-ACCESS-KEY 不能为空
50104请求头 OK-ACCESS-PASSPHRASE 不能为空
50105请求头 OK-ACCESS-PASSPHRASE 错误
50106请求头 OK-ACCESS-SIGN 不能为空
50107请求头 OK-ACCESS-TIMESTAMP 不能为空
50111无效的 OK-ACCESS-KEY
50112无效的 OK-ACCESS-TIMESTAMP
50113无效的签名

2. 请求错误#

错误码HTTP 状态描述
50011429用户请求频率过快,超过该接口允许的限额
50014400必填参数 {param} 不能为空

3. 业务错误#

错误码HTTP 状态描述
50026500系统错误,请稍后重试
81001200{param} 参数错误
81004200不支持的链
80007200风险地址

4. verify / settle 业务字段#

exact 接口的失败原因通过响应 data 中的 invalidReason(verify)或 errorReason(settle / settle/status)返回,常见取值:

字段值适用接口描述
insufficient_fundsverify, settle付款方余额不足
nonce_already_usedverify, settlenonce 已被使用
expired_authorizationverify, settle授权已过期
signature_invalidverify, settle签名校验失败
requirements_mismatchverify, settleacceptedpaymentRequirements 不一致
transaction_revertedsettle链上交易回滚
chain_unavailablesettle链上 RPC 不可用
not_foundsettle/statustxHash 不在 Broker 记录中

5. charge 业务错误#

错误码错误名称描述
8000SERVICE_ERRORAPI 服务内部错误
70000invalid_params缺少必填字段或格式错误
70001unsupported_chain链不在支持列表
70002payer_blocked付款方在黑名单
70003invalid_credentialsource 缺失、或 txHash 已被使用
70004invalid_signature签名验证失败
70005split_sum_exceeds_total分账总额 >= 总金额
70006split_count_exceeded分账数量 > 10
70007tx_not_confirmed交易未在链上确认
70009challenge_invalidChallenge 不存在或已过期