Submit transaction#

Settle the submitted transaction on the blockchain.

Request address#

POST https://web3.okx.com/api/v6/x402/settle

Request parameters#

Request body

Parameter	Type	Required	Description
x402Version	String	Yes	Version of the x402 protocol (e.g. 1)
chainIndex	String	Yes	Unique identifier of the blockchain
paymentPayload	Object	Yes	The x402 payment payload carried by the client with the protected request
>x402Version	String	Yes	Version of the x402 protocol (e.g. 1)
>scheme	String	Yes	Settlement scheme defining how the payment is processed, e.g. exact (one‑time fixed‑amount payment)
>payload	Object	Yes	Object containing payment signature and authorization data
>>signature	String	Yes	Cryptographic signature
>>authorization	Object	Yes	Authorization information
>>>from	String	Yes	Payer address
>>>to	String	Yes	Payee address
>>>value	String	Yes	Payment amount (in smallest unit, with precision)
>>>validAfter	String	No	Effective time (Unix timestamp)
>>>validBefore	String	No	Expiration time (Unix timestamp)
>>>nonce	String	Yes	Random nonce to prevent replay attacks
paymentRequirements	Object	Yes	Information describing what resource the payment grants access to (including amount, network, asset, and payee)
>scheme	String	Yes	Defines how the payment is settled, e.g. exact (one‑time fixed‑amount payment)
>resource	String	No	Server URL of the resource
>description	String	No	Description of the resource API endpoint
>mimeType	String	No	MIME type of the resource provider’s response
>maxAmountRequired	String	Yes	Maximum payable amount (in smallest unit, with precision)
>maxTimeoutSeconds	Integer	No	Maximum waiting time in seconds after the authorization becomes valid
>payTo	String	Yes	Payee address
>asset	String	No	Asset identifier or contract address (depending on the network)
>outputSchema	Object	No	Expected JSON structure of the returned resource data
>extra	Object	No	Additional parameters, e.g. gasLimit

Response parameter#

Parameter	Type	Description
chainIndex	String	Unique identifier of the blockchain, e.g. 196: X Layer
chainName	String	Name of the blockchain, e.g. X Layer
success	Boolean	Indicates whether the settlement was successful
payer	String	Address of the payer
txHash	String	Transaction hash of the settlement (EVM: 0x hash; Solana: Base58)
errorMsg	String	Error message, e.g. insufficient_funds, invalid_payload, etc

Get basic information of the protocol

Verify the transaction

Request example#

curl --location --request POST 'https://web3.okx.com/api/v6/wallet/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": 1,
  "paymentPayload": {
    "x402Version": 1,
    "scheme": "exact",
    "chainIndex": "196",,
    "payload": {
      "signature": "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480",
      "authorization": {
        "from": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
        "to": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
        "value": "1000000000000000000",
        "validAfter": "1716150000",
        "validBefore": "1716150000",
        "nonce": "0x1234567890abcdef1234567890abcdef12345678"
      }
    }
  },
  "paymentRequirements": {
    "scheme": "exact",
    "chainIndex": "196",,
    "maxAmountRequired": "1000000",
    "resource": "https://api.example.com/premium/resource/123",
    "description": "Premium API access for data analysis",
    "mimeType": "application/json",
    "outputSchema": {
      "data": "string"
    },
    "payTo": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "maxTimeoutSeconds": 10,
    "asset": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "extra": {
      "gasLimit": "1000000"
    }
  }
}'

Response example#

200

{
    "code": "0",
    "msg": "success",
    "data": [
        {
            "success": true,
            "errorReason": null,
            "payer": "0xcb30ed083ad246b126a3aa1f414b44346e83e67d",
            "txHash": "0x4f46ed8eac92ddbccfb56a88ff827db3616c7beb191adabbeeded901340bd7d5",
            "chainIndex": "196",
            "chainName": "X Layer"
        }
    ]
}

Get basic information of the protocol

Verify the transaction