settle

Body

application/json

x402Version

enum<integer>

required

The version of the x402 protocol.

Available options:

1

Example:

1

paymentPayload

object

required

The x402 protocol payment payload attached to X-PAYMENT header.

Show child attributes

paymentPayload.x402Version

enum<integer>

required

The version of the x402 protocol.

Available options:

1

Example:

1

paymentPayload.scheme

enum<string>

required

Available options:

exact

Example:

"exact"

paymentPayload.network

enum<string>

required

Available options:

mesherX,

mesherX-testnet

Example:

"mesherX"

paymentPayload.payload

x402ExactEvmPayload · object

required

The x402 protocol exact scheme payload for EVM networks. Implemented using ERC-3009.

Show child attributes

paymentPayload.payload.signature

string

required

The EIP-712 hex-encoded signature of the ERC-3009 authorization message.

Example:

"0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480"

paymentPayload.payload.authorization

object

required

The authorization data for the ERC-3009 message.

Show child attributes

paymentPayload.payload.authorization.from

string

required

0x-prefixed, checksum EVM address of the sender.

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

paymentPayload.payload.authorization.to

string

required

0x-prefixed, checksum EVM address of the recipient.

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

paymentPayload.payload.authorization.value

string

required

Value of the payment in atomic units.

Example:

"1000000000000000000"

paymentPayload.payload.authorization.validAfter

string

required

Unix timestamp after which payment is valid.

Example:

"1716150000"

paymentPayload.payload.authorization.validBefore

string

required

Unix timestamp before which payment is valid.

Example:

"1716150000"

paymentPayload.payload.authorization.nonce

string

required

Hex-encoded nonce of the payment.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

Example:

{
  "from": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "to": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "value": "1000000000000000000",
  "validAfter": "1716150000",
  "validBefore": "1716150000",
  "nonce": "0x1234567890abcdef1234567890abcdef12345678"
}

Example:

{
  "signature": "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480",
  "authorization": {
    "from": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "to": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "value": "1000000000000000000",
    "validAfter": "1716150000",
    "validBefore": "1716150000",
    "nonce": "0x1234567890abcdef1234567890abcdef12345678"
  }
}

Example:

{
  "x402Version": 1,
  "scheme": "exact",
  "network": "mesherX",
  "payload": {
    "signature": "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480",
    "authorization": {
      "from": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "to": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "value": "1000000000000000000",
      "validAfter": "1716150000",
      "validBefore": "1716150000",
      "nonce": "0x1234567890abcdef1234567890abcdef12345678"
    }
  }
}

paymentRequirements

object

required

The payment requirements expected by the resource server.

Show child attributes

paymentRequirements.scheme

enum<string>

required

Available options:

exact

Example:

"exact"

paymentRequirements.network

enum<string>

required

Available options:

mesherX,

mesherX-testnet

Example:

"mesherX"

paymentRequirements.maxAmountRequired

string

required

Example:

"1000000"

paymentRequirements.resource

string<uri>

required

A valid HTTPS URL.

Required string length: 11 - 2048

Example:

"https://api.example.com/premium/resource/123"

paymentRequirements.description

string

required

Example:

"Premium API access for data analysis"

paymentRequirements.mimeType

string

required

Example:

"application/json"

paymentRequirements.payTo

string

required

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

paymentRequirements.maxTimeoutSeconds

integer

required

Example:

10

paymentRequirements.asset

string

required

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

paymentRequirements.outputSchema

object

Example:

{ "data": "string" }

paymentRequirements.extra

object

Example:

{ "gasLimit": "1000000" }

Response

Successfully settled payment on the x402 protocol.

success

boolean

required

Indicates whether the payment settlement is successful.

Example:

false

payer

string

required

The onchain address of the client paying for the resource.

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

transaction

string

required

The settlement transaction hash.

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

network

string

required

The network where settlement occurred.

Example:

"mesherX"

errorReason

enum<string>

The reason the payment settlement errored on the x402 protocol.

Available options:

insufficient_funds,

invalid_scheme,

invalid_network,

invalid_x402_version,

invalid_payment_requirements,

invalid_payload,

invalid_exact_evm_payload_authorization_value,

invalid_exact_evm_payload_authorization_valid_after,

invalid_exact_evm_payload_authorization_valid_before,

invalid_exact_evm_payload_authorization_typed_data_message,

invalid_exact_evm_payload_authorization_from_address_kyt,

invalid_exact_evm_payload_authorization_to_address_kyt,

invalid_exact_evm_payload_signature_address,

settle_exact_svm_block_height_exceeded,

settle_exact_svm_transaction_confirmation_timed_out

Example:

"insufficient_funds"

Development

ASDO

x402

Body

Response