Skip to main content
POST
cURL

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.

Example:
paymentRequirements
object
required

The payment requirements expected by the resource server.

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.

Pattern: ^0x[a-fA-F0-9]{40}|[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

transaction
string
required

The settlement transaction hash.

Pattern: ^0x[a-fA-F0-9]{40}|[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
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"