x402

Settle payment

Settle an x402 payment. Compatible with any standard x402 middleware.

post/v1/payments/x402/settle

Request

Base URL
https://api.thirdweb.com
Auth
API key in header x-secret-key

Request body

waitUntil'simulated' | 'submitted' | 'confirmed'

The event to wait for to determina a transaction confirmation. 'simulated' will only simulate the transaction (fastest), 'submitted' will wait till the transaction is submitted, and 'confirmed' will wait for the transaction to be fully confirmed on chain (slowest). Defaults to 'confirmed'.

Example request

{
  "paymentPayload": {
    "network": "eip155:1"
  },
  "paymentRequirements": {
    "network": "eip155:1"
  }
}

Response

Settlement successful

successboolean required

errorReason'insufficient_funds' | 'invalid_exact_evm_payload_authorization_valid_after' | 'invalid_exact_evm_payload_authorization_valid_before' | 'invalid_exact_evm_payload_authorization_value' | 'invalid_exact_evm_payload_signature' | 'invalid_exact_evm_payload_recipient_mismatch' | 'invalid_exact_svm_payload_transaction' | 'invalid_exact_svm_payload_transaction_amount_mismatch' | 'invalid_exact_svm_payload_transaction_create_ata_instruction' | 'invalid_exact_svm_payload_transaction_create_ata_instruction_incorrect_payee' | 'invalid_exact_svm_payload_transaction_create_ata_instruction_incorrect_asset' | 'invalid_exact_svm_payload_transaction_instructions' | 'invalid_exact_svm_payload_transaction_instructions_length' | 'invalid_exact_svm_payload_transaction_instructions_compute_limit_instruction' | 'invalid_exact_svm_payload_transaction_instructions_compute_price_instruction' | 'invalid_exact_svm_payload_transaction_instructions_compute_price_instruction_too_high' | 'invalid_exact_svm_payload_transaction_instruction_not_spl_token_transfer_checked' | 'invalid_exact_svm_payload_transaction_instruction_not_token_2022_transfer_checked' | 'invalid_exact_svm_payload_transaction_not_a_transfer_instruction' | 'invalid_exact_svm_payload_transaction_receiver_ata_not_found' | 'invalid_exact_svm_payload_transaction_sender_ata_not_found' | 'invalid_exact_svm_payload_transaction_simulation_failed' | 'invalid_exact_svm_payload_transaction_transfer_to_incorrect_ata' | 'invalid_network' | 'invalid_payload' | 'invalid_payment_requirements' | 'invalid_scheme' | 'invalid_payment' | 'payment_expired' | 'unsupported_scheme' | 'invalid_x402_version' | 'invalid_transaction_state' | 'invalid_x402_version' | 'settle_exact_svm_block_height_exceeded' | 'settle_exact_svm_transaction_confirmation_timed_out' | 'unsupported_scheme' | 'unexpected_settle_error' | 'unexpected_verify_error'

transactionstring required

errorMessagestring

fundWalletLinkstring

Changes

No recorded changes to this operation across all 5 revisions of this API.