Binance Web3 API

Schemas

TokenResp

Token balance information within a position.

tokenAddress

string

Token contract address. The native-asset sentinel 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee (40 es) for native coins.

Example: 0x55d398326f99059fF775485246999027B3197955

tokenName

string

Token name.

Example: Tether USDt

tokenSymbol

string

Token symbol.

Example: USDT

tokenAmount

string

Human-readable token amount (NOT the smallest unit).

Example: 10.514497309269952983

tokenPrice

string

Current token price in USD.

Example: 0.9996875708132666

tokenValue

string

Token value in USD (amount × price).

Example: 10.51121227

tokenDecimals

string

Token decimals (string).

Example: 18

PositionDetailResp

PositionResp

A single DeFi position with underlying asset and token breakdown.

positionId

string

Unique position identifier (64-char hex, no 0x prefix).

Example: dbc71cba52420db0021821a240a3901df566fbcda97b663402ec7d52308f0e29

underlyingAssetName

string

Display name of the underlying asset (e.g. "USDT-USDC", "lisUSD").

Example: USDT-USDC

underlyingAssetId

string

Underlying asset identifier (64-char hex, no 0x prefix). Hashed from the pool and underlying token addresses.

Example: e73d51bced063d9e7bd5d799e51752ffb7bc6fbfa579ce41164d0dbd9cc13a4b

assetType

string | null

Asset structure type. Null for a regular position; locked for a locked position (e.g. locked staking — check unlockTime on positionDetail); farming for a MasterChef-style farming position (rewards accrue under the farming_reward token group).

Example: locked

investmentIds

string[]

Related investment IDs (64-char hex, no 0x prefix). Use with POST /api/v1/defi/data/investment/detail. Usually a single entry; a position can relate to several investments when the pool stacks products on top of each other (e.g. a farming position wraps the underlying LP investment plus its incentive product, or a staked vault layers a receipt token over the base deposit). When there are several, query each with investment/detail and pick by the action you want to perform — redeeming the principal uses the base investment, claiming farming incentives uses the incentive one.

Example: ["b3e50a2dd4aab008d3410dae2a383fe5216346fb613bb1bef9b1822fe47c742a"]

positionDetail

object | null

Position-level metadata. Present for concentrated-liquidity / locked / farming positions; null otherwise. Fields are null when not applicable to the position type.

positionValue

string

Total position value in USD (sum of all token values; may be negative for borrow positions).

Example: 10.51121227

object

Token breakdown grouped by role. Keys: supply (supplied assets), borrow (borrowed assets, lending positions), reward (claimable rewards), farming_reward (MasterChef farming incentives). A key is absent when the position has no tokens in that role.

Example: {"supply":[{"tokenAddress":"0x55d398326f99059fF775485246999027B3197955","tokenSymbol":"USDT","tokenAmount":"1000.5","tokenValue":"1000.6"}],"reward":[{"tokenAddress":"0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82","tokenSymbol":"Cake","tokenAmount":"12.3","tokenValue":"45.6"}]}

PoolDetailResp

PositionCollectionResp

A collection of positions grouped under the same underlying asset.

positionCollectionId

string

Collection unique identifier (64-char hex, no 0x prefix).

Example: 85dab74a61426fa11f02a234d5e4462c7cc62249875c212f2dbfa09a927b8097

positionCollectionDetail

object | null

Collection metadata. Null when the collection has no metadata. Fields are null when not applicable.

positionCollectionTotalValue

string

Total value of all positions in this collection (USD).

Example: 10.51121227

object[]

List of positions in this collection.

PoolResp

A pool containing position collections.

bnPoolId

string

Pool identifier (0x + 64-char hex).

Example: 0xd4e9b3f0fbb5129bf893f01df339935185b5ad22492fac093f391753389a8656

poolCa

string

Pool contract address.

Example: 0x3662d86220BE5BEA975BE9Fd8aB3d6b5D4FB4163

poolType

string

Pool type. Complete value set: Lending (supply/borrow market), Staked (native staking), Yield (yield vault / receipt token), Deposit (fixed deposit), Rewards (reward claims, e.g. PancakeSwap Infinity), Liquidity Pool (AMM / concentrated liquidity), Farming (MasterChef farming), Locked (locked staking with unlock time), Vesting (vesting schedule). Treat unknown values as generic display.

Example: Liquidity Pool

object[]

poolDetail

object | null

Pool-level metadata. Fields are null when not applicable to the pool type (e.g. tickSpacing/hooks only for concentrated-liquidity pools).

ProtocolResp

Protocol-level position summary for one address on one chain. `binanceChainId` + `defiProtocolId` uniquely identify a protocol on a chain.

binanceChainId

string

Binance chain ID (e.g. "56"=BSC).

Example: 56

defiProtocolId

string

Protocol identifier consistent with POST /api/v1/defi/data/protocol/list. Use this value when calling investment/list, transaction endpoints, etc.

Example: helio

protocolName

string

Protocol display name.

Example: Lista DAO

protocolTotalValue

string

Total position value in this protocol (USD).

Example: 26.70787419

object[]

Pools with positions in this protocol.

AddressResp

Address-level aggregation. Groups the protocol-level position summaries of one wallet address.

address

string

Wallet address.

Example: 0x66faa5ded68cc83a71bc172fb03c17a6bcb32f7a

addressTotalValue

string

Total DeFi position value of this address across all chains (USD). Same raw precision as the position values.

Example: 26.70787419

object[]

Protocol-level position summaries of this address.

PositionListResp

Aggregated DeFi positions response.

totalValue

string

Total value of all DeFi positions of all queried addresses (USD). Same raw precision as addressTotalValue.

Example: 5000.50123456

object[]

Address-level position summaries.

DefiProtocolDto

DeFi protocol summary (list item).

defiProtocolId

string

DeFi protocol identifier.

Example: pancakeswap3

protocolName

string

Protocol display name.

Example: PancakeSwap V3

protocolLogo

string

Protocol logo image URL (full URL; quote as-is).

Example: https://bin.bnbstatic.com/image/admin_mgs_image_upload/20250228/pancakeswap-logo.png

tvl

string

Total value locked in the protocol (USD). String, raw precision from the data source.

Example: 1250000.5

apyBps

integer · int64

Highest APY across the protocol's investments, in basis points (1 bps = 0.01%). Integer value — use this for sorting / comparing / filtering, never the raw decimal.

Example: 1235

apyDisplay

string

Pre-formatted, human-readable APY string for display (e.g. "12.35%"). Quote as-is; do not re-compute or transform.

Example: 12.35%

investType

string[]

Investment types supported by this protocol — an array here (a protocol may support several). Note: the investment-level investType (in investment list/detail) is a single string. Known values: Earn, LiquidityPool.

Example: ["Earn","LiquidityPool"]

supportedChains

string[]

Supported Binance chain IDs.

Example: ["56"]

DefiProtocolSocialLinksDto

Protocol social media links.

x

string | null

X (Twitter) profile URL. Null when not available.

Example: https://x.com/pancakeswap

discord

string | null

Discord invite URL. Null when not available.

Example: null

github

string | null

GitHub organization URL. Null when not available.

Example: https://github.com/pancakeswap

linkedin

string | null

LinkedIn company URL. Null when not available.

Example: https://www.linkedin.com/company/pancakeswap/

telegram

string | null

Telegram channel URL. Null when not available.

Example: null

gitbook

string | null

GitBook documentation URL. Empty string or null when not available.

Example:

website

string

Official website URL.

Example: https://pancakeswap.finance/

DefiProtocolTeamMemberDto

Protocol team member.

name

string

Member name.

Example: Henry Cavill

role

string

Member role / title.

Example: CEO

twitter

string | null

Member's X (Twitter) handle URL. Null when not available.

Example: https://x.com/0xchefjackson

linkedin

string | null

Member's LinkedIn URL. Null when not available.

Example: https://www.linkedin.com/in/henry-cavill-6b6ab6229/

bio

string | null

Member biography. Null when not available.

Example: null

DefiProtocolFundRaisingDto

Fundraising round.

round

string

Round name (e.g. "Strategic").

Example: Strategic

amount

string | null

Amount raised. Null when not disclosed.

Example: null

date

string

Round date.

Example: 2022-06-06

investors

string[]

Investor names.

Example: ["YZi Labs"]

DefiProtocolDimensionScoresDto

CertiK six-dimension security scores.

codeSecurity

string

Code security score.

Example: 95.47

fundamentalHealth

string

Fundamental health score.

Example: 76.7

operationalResilience

string

Operational resilience score.

Example: 94.96

communityTrust

string

Community trust score.

Example: 98

governanceStrength

string

Governance strength score.

Example: 98

marketStability

string

Market stability score.

Example: 96

DefiProtocolFaqDto

FAQ entry.

title

string

FAQ question text (already translated; quote as-is).

Example: How are rewards accrued from providing liquidity on Pancakeswap V3?

answer

string

FAQ answer text (already translated; quote as-is). May contain line-break markup <Br/> and paragraph-gap markup <Gap/> — interpret them as line / paragraph breaks.

Example: • Rewards come from trading fees collected on swaps within your liquidity price range.<Br/>• Fees accumulate and increase your liquidity position value.<Br/>• Fees are accrued only when the market is trading within the range set by you.

DefiProtocolInfoDto

DeFi protocol detail.

defiProtocolId

string

DeFi protocol identifier.

Example: pancakeswap3

protocolName

string

Protocol display name.

Example: PancakeSwap

protocolLogo

string

Protocol logo image URL (full URL under https://bin.bnbstatic.com).

Example: https://bin.bnbstatic.com/image/admin_mgs_image_upload/20250527/06ab0ee1-8382-4416-9395-15446112b09b.png

description

string

Protocol description (already translated; quote as-is).

Example: PancakeSwap is a decentralized exchange (DEX) built on BNB Chain that utilizes an automated market making (AMM) system.

websiteUrl

string

Official website URL.

Example: https://pancakeswap.finance/

investType

string[]

Example: ["LiquidityPool"]

supportedChains

string[]

Supported Binance chain IDs.

Example: ["56"]

tvl

string

Total value locked (USD). String, raw precision from the data source.

Example: 290233074

tags

string[]

Protocol tags / categories.

Example: ["DeFi","DEX"]

founded

string

Founding year (YYYY).

Example: 2020

fdv

string

Fully diluted valuation.

Example: 510239911.86046

totalFunding

string | null

Total funding raised. Null when not disclosed.

Example: null

object

Protocol social media links.

object[]

Team members.

object[]

Fundraising history.

securityScore

string

Overall CertiK security score.

Example: 92.33

object

CertiK six-dimension security scores.

highlights

string[]

Protocol highlights (already translated; quote as-is).

Example: ["Project has security audits","Code repo health is in excellent condition"]

object[]

FAQ entries (question and answer text, already translated).

DefiInvestmentDto

DeFi investment product summary (list item).

binanceChainId

string

Binance chain ID.

Example: 56

defiProtocolId

string

Parent DeFi protocol identifier.

Example: pancakeswap3

protocolName

string

Protocol display name.

Example: PancakeSwap V3

investmentId

string

Investment product identifier (64-char hex, no 0x prefix). Same format as the investmentIds returned by POST /api/v1/defi/data/position/list and accepted by the transaction build endpoints.

Example: fc546857d03bf5f7ca15d01c564c8430599f6fd8ec3c2dda0119b8a7e7e793e8

investmentName

string

Investment display name.

Example: USDT-MarsCoin

investType

string

Investment type of this product — a single string here (each product has exactly one). Note: the protocol-level investType (in protocol list/detail) is an array. Known values: Earn, LiquidityPool.

Example: LiquidityPool

apyType

string

Rate yield type. Known values: APY, APR.

Example: APR

apyBps

integer · int64

Annual percentage yield in basis points (1 bps = 0.01%). Integer value — use this for sorting / comparing / filtering, never the raw decimal.

Example: 156265

apyDisplay

string

Pre-formatted, human-readable APY string for display (e.g. "1,562.65%"). Quote as-is; do not re-compute or transform.

Example: 1,562.65%

tvl

string

Total value locked in this investment (USD). String, raw precision from the data source.

Example: 352489.87

DefiInvestmentTokenDto

Token in an investment product.

tokenAddress

string

Token contract address. The native-asset sentinel for native coins.

Example: 0x55d398326f99059fF775485246999027B3197955

tokenName

string

Token name.

Example: Tether USD

tokenSymbol

string

Token symbol.

Example: USDT

DefiInvestmentInfoDto

DeFi investment product detail.

binanceChainId

string

Binance chain ID.

Example: 56

defiProtocolId

string

Parent DeFi protocol identifier.

Example: pancakeswap3

protocolName

string

Protocol display name.

Example: PancakeSwap V3

protocolLogo

string

Protocol logo image URL (full URL; quote as-is).

Example: https://bin.bnbstatic.com/image/admin_mgs_image_upload/20250228/pancakeswap-logo.png

investmentId

string

Investment product identifier (64-char hex, no 0x prefix). Same format as the investmentIds returned by POST /api/v1/defi/data/position/list and accepted by the transaction build endpoints.

Example: fc546857d03bf5f7ca15d01c564c8430599f6fd8ec3c2dda0119b8a7e7e793e8

investmentName

string

Investment display name.

Example: USDT-MarsCoin

investType

string

Investment type of this product — a single string here (each product has exactly one). Note: the protocol-level investType (in protocol list/detail) is an array. Known values: Earn, LiquidityPool.

Example: LiquidityPool

investable

boolean

Whether this investment is currently investable.

Example: true

apyBps

integer · int64

Annual percentage yield in basis points (1 bps = 0.01%). Integer value — use this for sorting / comparing / filtering, never the raw decimal.

Example: 156265

apyDisplay

string

Pre-formatted, human-readable APY string for display (e.g. "1,562.65%"). Quote as-is; do not re-compute or transform.

Example: 1,562.65%

apyType

string

Rate yield type. Known values: APY, APR.

Example: APR

tvl

string

Total value locked (USD). String, raw precision from the data source.

Example: 500000.5

poolAddress

string

Pool / strategy contract address.

Example: 0x87870Bca3F3fF67225794148012b73643B78Ed36

feeRate

string

Fee rate string (e.g. "0.001" = 0.1%).

Example: 0.001

object[]

Tokens to supply / deposit.

object[]

Reward tokens.

object[]

LP tokens (for liquidity positions).

object[]

Borrow tokens (for lending borrow positions).

ProtocolPageResult

Paginated protocol list result.

page

integer

Current page number (1-based).

Example: 1

size

integer

Page size.

Example: 20

total

integer · int64

Total number of records.

Example: 10

object[]

Protocols for the current page.

InvestmentPageResult

Paginated investment list result.

page

integer

Current page number (1-based).

Example: 1

size

integer

Page size.

Example: 20

total

integer · int64

Total number of records.

Example: 290

object[]

Investments for the current page.

DefiTokenItem

A `(tokenAddress, amount)` pair. `amount` is a human-readable decimal string (NOT the token's smallest unit); the service converts it according to the token's decimals. For the native asset use the sentinel `0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee` (40 `e`s).

tokenAddress

string · required

Token contract address; the native-asset sentinel for the native coin.

Example: 0x55d398326f99059fF775485246999027B3197955

amount

string · required

Human-readable amount as a decimal string, e.g. "1.5", "100".

Example: 100

DefiClaimType

string · enum

Enum values:

REWARD_PROTOCOL

REWARD_INVESTMENT

LP_FEE

REDEMPTION

Claim routing type. Determines which companion fields are required:

REWARD_PROTOCOL: protocol-level rewards (e.g. Aave incentive, Radiant) — requires defiProtocolId + binanceChainId
REWARD_INVESTMENT: per-investment rewards — requires investmentId
LP_FEE: Uniswap V3/V4 LP fees — requires investmentId + nftId
REDEMPTION: redeem principal (Lista / Aster / Solv etc.) — requires investmentId + redemptionId

Protocol constraints — not every claimType is valid for every protocol; an invalid combination is rejected (40453 or 40454):

REWARD_PROTOCOL is not supported for LP (liquidity-pool) protocols in this release.
REWARD_INVESTMENT is not supported for PancakeSwap V3 farming positions; use LP_FEE to claim farming incentives there.
LP_FEE applies only to concentrated-liquidity (V3/V4) LP positions.
REDEMPTION applies only to protocols with a redemption / lock-up flow (Lista, Aster, Solv).

The valid claimTypes for a specific position are returned in that position's positionDetail.claimTypes (see the position list) — branch on that rather than hard-coding the mapping. Note: error messages may surface the protocol id with a chain prefix (e.g. bsc_pancakeswap4); the canonical id in API fields is the un-prefixed form (e.g. pancakeswap4).

Example: LP_FEE

DefiCallDataItem

A single unsigned transaction to sign and broadcast. The `dataList` is ordered: APPROVE items precede the main action. EVM chains return `to`/`value` (hex) and hex calldata in `data`. **Number-format conventions for this object** — `value` is a `0x`-prefixed hex string; `gasLimit`, `gasPrice`, `maxPriorityFeePerGas`, and `maxFeePerGas` are decimal strings. Mixed hex/decimal within the same object is by design (it mirrors the on-chain transaction fields); always parse gas fields with base-10 and `value` with base-16. **BSC and EIP-1559**: this release is BSC only. BSC is an EIP-1559 chain, so build responses populate `maxFeePerGas` and `maxPriorityFeePerGas`; `gasPrice` is `null` (legacy-only). The nullable markers below are retained so the schema also describes non-1559 chains in later releases — on BSC the 1559 fields are present and the legacy `gasPrice` is `null`. `to` and `value` are non-null for every action item on BSC.

callDataType

string · enum

Action kind of this item:

APPROVE — ERC-20 approval, must be signed/broadcast and confirmed before the main action
DEPOSIT / REDEEM / LP_ADD / LP_REMOVE / CLAIM — the main action. LP_ADD / LP_REMOVE are the LP add / remove legs (the same build path as deposit / redeem for liquidity-pool investments; the kind reflects the on-chain action, not the entry endpoint).

Enum values:

APPROVE

DEPOSIT

REDEEM

LP_ADD

LP_REMOVE

CLAIM

Example: DEPOSIT

from

string

User wallet address (the signer / sender). EIP-55 checksummed — normalize with to_checksum_address before signing if your signer requires it.

Example: 0x1234567890123456789012345678901234567890

to

string | null

Target contract address. EIP-55 checksummed, same format as from. Non-null on BSC for every action item.

Example: 0x87870Bca3F3fF67225794148012b73643B78Ed36

value

string | null

Native-asset value as a 0x-prefixed hex string. Non-null on BSC for action items.

Example: 0x0

data

string

Serialized transaction data, as a 0x-prefixed hex calldata string.

Example: 0xa9059cbb000000000000000000000000dead00000000000000000000000000000000dead00000000000000000000000000000000000000000000000000000000000000000a

gasLimit

string | null

Suggested gas limit (decimal string). null when estimation fails.

Example: 200000

gasPrice

string | null

Legacy gas price, decimal string. null on EIP-1559 chains such as BSC (use maxFeePerGas / maxPriorityFeePerGas instead).

Example: 3000000000

maxPriorityFeePerGas

string | null

EIP-1559 priority fee in wei (decimal string). null on non-1559 chains.

Example: 1000000000

maxFeePerGas

string | null

EIP-1559 max fee per gas in wei (decimal string). null on non-1559 chains.

Example: 3000000000

DefiPreview

Simulation result returned by the build endpoints when `simulate=true`. Includes whether the action is expected to succeed, the projected balance change, the estimated network fee, and — for lending protocols — the health-factor change. `balanceChange`, `feeAndContract`, `healthFactor`, and `warnings` each have a fixed structure (see below); the number of entries and some inner values vary by protocol.

success

boolean

Whether the simulated transaction is expected to succeed on-chain.

Example: true

object[]

Signed token balance deltas from the simulation. Each entry has tokenType, tokenSymbol, tokenAddress, tokenDecimals, amount (positive = received, negative = spent), valueUsd, and an optional tokenId.

object

Estimated network fee and the contract the action interacts with. Contains estimatedNetworkFee and interactWith.

Example: {"estimatedNetworkFee":{"amount":"0.000003056787","tokenSymbol":"BNB","valueUsd":"0.002002","rentFeeAmount":null,"rentFeeValueUsd":null,"priorityFeeAmount":null},"interactWith":{"address":"0xae05cd22df81871bc7cc2a04becfb516bfe332c8"}}

object

Lending health-factor change. Contains before / after values for lending protocols (e.g. Aave / Venus); null for non-lending protocols or when health factor is unavailable.

Example: {"before":"1.85","after":"1.35"}

object[]

Non-blocking risk warnings. Empty array when there are no warnings.

errorMessage

string

Error message when the simulated transaction is expected to fail.

Example: insufficient balance

DefiTxResponse

Unified response of the five build endpoints (deposit / redeem / lp-add / lp-remove / claim). `dataList` is ordered: APPROVE items come first, the main action follows — sign and broadcast each item in order. `preview` is non-null only when the request set `simulate=true`. `redeemDelayDays` is populated only by `/transaction/redeem`.

object[]

Ordered unsigned transactions; APPROVE precedes the main action.

object

Simulation result returned by the build endpoints when simulate=true. Includes whether the action is expected to succeed, the projected balance change, the estimated network fee, and — for lending protocols — the health-factor change. balanceChange, feeAndContract, healthFactor, and warnings each have a fixed structure (see below); the number of entries and some inner values vary by protocol.

redeemDelayDays

string[]

Redeem waiting period as a [min, max] day pair of decimal strings. Populated only by /transaction/redeem; null on the other build endpoints or when unavailable. Interpretation: [] (empty) = instant, no waiting period; ["7","7"] = fixed 7 days; ["7","10"] = 7–10 days. The wait starts after the redeem transaction is confirmed on-chain.

Example: ["7","10"]

LpAddCalculateResponse

Result of `/transaction/lp-add/calculate`. Returns the paired token amounts derived from the single input token. This endpoint is pure computation — it does not touch the chain and does not deduct any fee.

inputTokenAmount

string

Echo of the input token amount (human-readable).

Example: 10

pairedTokenAddress

string

The paired token contract address derived from the investment.

Example: 0xf1686b0b45114bcec963b139344a54cefae09a58

pairedTokenAmount

string

Calculated paired token amount (human-readable).

Example: 20

B402RequestEnvelopeSupported

body

object · required

B402ApiErrorEnvelope

status

string

Example: ERROR

type

string

Example: GENERAL

code

string

Example: 1160401

errorData

string | null

Example: Merchant not found

data

object | null

Example: null

subData

object | null

Example: null

params

object | null

Example: null

B402PaymentKindExtraV2

name

string · required

Example: Token Name

version

string · required

Example: 1

assetTransferMethod

string · enum · required

Enum values:

eip3009

permit2-exact

permit2-upto

signerAddress

string · required

Example: 0x3333333333333333333333333333333333333333

spenderAddress

string | null

Example: 0x4444444444444444444444444444444444444444

B402PaymentKindV2

x402Version

integer · enum · required

Enum values:

scheme

string · enum · required

Enum values:

exact

upto

network

string · required

Example: eip155:56

object · required

B402SupportedDataV2

object[] · required

extensions

string[] · required

Example: []

object · required

Example: {"eip155:*":["0x3333333333333333333333333333333333333333"]}

B402SupportedResponseV2

status

string

Example: OK

type

string

Example: GENERAL

code

string

Example: 000000000

errorData

string | null

Example: null

object

subData

object | null

Example: null

params

object | null

Example: null

B402ResourceInfoV2

url

string · uri · required

Example: https://merchant.example.com/weather

description

string

Example: Premium weather report

mimeType

string

Example: application/json

B402PaymentRequirementsExtraV2

name

string · required

Example: Token Name

version

string · required

Example: 1

assetTransferMethod

string · enum · required

Enum values:

eip3009

permit2-exact

permit2-upto

signerAddress

string · required

Example: 0x3333333333333333333333333333333333333333

spenderAddress

string | null

Example: 0x4444444444444444444444444444444444444444

B402PaymentRequirementsV2

scheme

string · enum · required

Enum values:

exact

upto

network

string · required

Example: eip155:56

amount

string · pattern: ^[0-9]+$ · required

Example: 1000000

asset

string · required

Example: 0x1111111111111111111111111111111111111111

payTo

string · required

Example: 0x2222222222222222222222222222222222222222

maxTimeoutSeconds

integer · required

Example: 300

object · required

B402Eip3009Authorization

from

string · required

Example: 0x5555555555555555555555555555555555555555

to

string · required

Example: 0x2222222222222222222222222222222222222222

value

string · required

Example: 1000000

validAfter

string · required

Example: 0

validBefore

string · required

Example: 1780000000

nonce

string · required

Example: 0x0000000000000000000000000000000000000000000000000000000000000001

B402Permit2Permitted

token

string · required

Example: 0x1111111111111111111111111111111111111111

amount

string · required

Example: 1000000

B402Permit2Witness

to

string · required

Example: 0x2222222222222222222222222222222222222222

validAfter

string · required

Example: 0

facilitator

string | null

Example: 0x3333333333333333333333333333333333333333

B402Permit2Authorization

object · required

from

string · required

Example: 0x5555555555555555555555555555555555555555

spender

string · required

Example: 0x4444444444444444444444444444444444444444

nonce

string · required

Example: 123456789

deadline

string · required

Example: 1780000000

object · required

B402PayloadDetail

signature

string · required

Example: 0xabcdef...

object

B402BazaarExtension

object · required

Example: {"input":{"type":"http","method":"GET"}}

object · required

Example: {"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"input":{"type":"object","properties":{"type":{"const":"http"},"method":{"enum":["GET"]}},"required":["type","method"]}},"required":["input"]}

routeTemplate

string

Example: /v1/weather/:city

description

string

Example: Hourly weather forecast by city

B402PaymentPayloadV2

x402Version

integer · enum · required

Enum values:

object · required

object

B402VerifyRequestV2

x402Version

integer · enum · required

Enum values:

object · required

B402VerifyEnvelopeV2

object · required

B402VerifyDataV2

isValid

boolean · required

Example: true

payer

string | null

Example: 0x5555555555555555555555555555555555555555

invalidReason

string | null

Example: invalid_payload

invalidMessage

string | null

Example: null

B402VerifyResponseV2

status

string

Example: OK

type

string

Example: GENERAL

code

string

Example: 000000000

errorData

string | null

Example: null

object

subData

object | null

Example: null

params

object | null

Example: null

B402SettleRequestV2

x402Version

integer · enum · required

Enum values:

object · required

settleAmount

string · pattern: ^[0-9]+$

Example: 750000

B402SettleEnvelopeV2

object · required

B402SettleDataV2

success

boolean · required

Example: true

transaction

string · required

Example: 0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

network

string · required

Example: eip155:56

payer

string | null

Example: 0x5555555555555555555555555555555555555555

amount

string

Example: 1000000

errorReason

string | null

Example: null

errorMessage

string | null

Example: null

object

Example: {}

B402SettleResponseV2

status

string

Example: OK

type

string

Example: GENERAL

code

string

Example: 000000000

errorData

string | null

Example: null

object

subData

object | null

Example: null

params

object | null

Example: null

B402PaymentKindExtraV1

name

string

Example: Token Name

version

string

Example: 1

assetTransferMethod

string · enum

Enum values:

eip3009

permit2-exact

permit2-upto

facilitatorAddress

string

Example: 0x3333333333333333333333333333333333333333

B402PaymentKindV1

x402Version

integer · enum

Enum values:

scheme

string · enum

Enum values:

exact

Example: exact

network

string

Example: eip155:56

object

B402SupportedDataV1

object[]

extensions

string[]

Example: []

object

Example: {"eip155:56":["0x3333333333333333333333333333333333333333"]}

B402SupportedResponseV1

status

string

Example: OK

type

string

Example: GENERAL

code

string

Example: 000000000

errorData

string | null

Example: null

object

subData

object | null

Example: null

params

object | null

Example: null

B402PaymentRequirementsV1

scheme

string · enum · required

Enum values:

exact

Example: exact

network

string · required

Example: eip155:56

amount

string · required

Example: 1000000

payTo

string · required

Example: 0x2222222222222222222222222222222222222222

asset

string · required

Example: 0x1111111111111111111111111111111111111111

maxTimeoutSeconds

integer · required

Example: 300

resource

string · uri

Example: https://merchant.example.com/weather

description

string

Example: Premium weather report

mimeType

string

Example: application/json

object

Example: {"type":"object"}

object

B402PaymentPayloadV1

x402Version

integer · enum · required

Enum values:

scheme

string · enum · required

Enum values:

exact

Example: exact

network

string · required

Example: eip155:56

object · required

B402VerifyRequestV1

x402Version

integer · enum · required

Enum values:

object · required

B402VerifyEnvelopeV1

object · required

B402VerifyResponseV1

status

string

Example: OK

type

string

Example: GENERAL

code

string

Example: 000000000

errorData

string | null

Example: null

object

subData

object | null

Example: null

params

object | null

Example: null

B402SettleRequestV1

x402Version

integer · enum · required

Enum values:

object · required

settleAmount

string · pattern: ^[0-9]+$

Example: 750000

B402SettleEnvelopeV1

object · required

B402SettleDataV1

success

boolean · required

Example: true

transaction

string | null

Example: 0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

payer

string | null

Example: 0x5555555555555555555555555555555555555555

network

string | null

Example: eip155:56

amount

string | null

Example: 1000000

confirmations

integer | null

Example: 1

errorReason

string | null

Example: null

errorMessage

string | null

Example: null

B402SettleResponseV1

status

string

Example: OK

type

string

Example: GENERAL

code

string

Example: 000000000

errorData

string | null

Example: null

object

subData

object | null

Example: null

params

object | null

Example: null