Quote a collection offer sale

POST

/v1/policy-accepts/preflight

curl --request POST \
  --url https://api.digirare.com/v1/policy-accepts/preflight \
  --header 'Content-Type: application/json' \
  --header 'x-session-token: <x-session-token>' \
  --data '{ "parent_txid": "example", "asset_txid": "example", "asset_vout": 1, "fee_rate": 1, "seller_min_net_sats": 1, "seller_tap_internal_key": "example" }'

For any attached, confirmed, one-unit asset UTXO the session owns (listed or merely prepared): checks eligibility and builds the v3 acceptance child (the seller pays the marketplace fee and the package network fee), returning the accept_policy_offer wallet request. A short-lived quote; reserves nothing. Every policy-offer route answers 503 service_unavailable when collection-offer signing is unavailable.

Authorizations

• session

Request Body^required

Media typeapplication/json

object

parent_txid

required

string

/^[0-9a-f]{64}$/

asset_txid

required

string

/^[0-9a-f]{64}$/

asset_vout

required

integer

fee_rate

number

>= 0.1 <= 500

seller_min_net_sats

integer

seller_tap_internal_key

string

/^[0-9a-f]+$/

Example^generated

{
  "parent_txid": "example",
  "asset_txid": "example",
  "asset_vout": 1,
  "fee_rate": 1,
  "seller_min_net_sats": 1,
  "seller_tap_internal_key": "example"
}

Responses

201

An unsigned v3 acceptance child and the accept_policy_offer wallet request

Media typeapplication/json

object

result

required

object

protocol_version

required

Allowed value: funded_policy_offer_v1

accept_id

required

string

parent_txid

required

string

/^[0-9a-f]{64}$/

funding_slot_id

string

seller

required

Mainnet P2TR or P2WPKH address. The SIGNING capability: every signature is verified by reconstructing a BIP-143/BIP-341 witness sighash.

string

asset

required

Canonical compact Counterparty key. A subasset uses its A ID; asset_longname is display metadata.

string

quantity_raw

string

/^(0|[1-9][0-9]*)$/

asset_outpoint

required

object

txid

required

string

/^[0-9a-f]{64}$/

vout

required

integer

utxo_value_sats

integer

>= 1 <= 9007199254740991

psbt_hex

required

string

/^[0-9a-f]+$/

expected_txid

required

string

/^[0-9a-f]{64}$/

price_sats

required

integer

>= 1 <= 9007199254740991

offer_value_sats

integer

>= 1 <= 9007199254740991

platform_fee_sats

required

integer

>= 1 <= 9007199254740991

network_fee_sats

required

integer

>= 1 <= 9007199254740991

seller_proceeds_sats

required

integer

>= 1 <= 9007199254740991

parent_vsize

required

integer

child_vsize

required

integer

package_vsize

integer

fee_rate

required

number

>= 0.1 <= 500

delivery

object

signing

object

intent

Accept_policy_offer wallet intent claim.

object

wallet_request

required

object

expires_at

required

integer

reserves_inventory

required

Example

{
  "result": {
    "protocol_version": "funded_policy_offer_v1",
    "reserves_inventory": false
  }
}

4XX

Stable machine-readable failure

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: invalid_request unsupported_address_type unauthenticated forbidden not_found method_not_allowed state_changed expired invalid_transaction rate_limited internal_error upstream_unavailable service_unavailable checkout_changed target_unavailable signature_invalid template_mismatch mempool_rejected broadcast_unknown conflict_spend duplicate_funding_slot offer_selection_unavailable attached_delivery_single_item_only insufficient_funds insufficient_asset_balance price_below_minimum listing_price_above_maximum counter_price_invalid self_trade offer_capacity_full open_offer_limit policy_offer_refused

retryable

boolean

mempool_policy

On 422 mempool_rejected from a broadcast: which deterministic node policy refused the bytes. Retrying the same bytes fails the same way. fee_floor: re-quote at a higher fee_rate. chain_too_long: too many unconfirmed ancestors; wait for a confirmation, then retry. truc: a version-3 (TRUC) package rule, such as spending an unconfirmed version-3 output; wait for a confirmation, then retry.

string

Allowed values: fee_floor chain_too_long truc dust nonstandard

mempool_reason

The node’s own reject reason, on mempool_rejected (422) and on state_changed (409) when a broadcast lost to a conflicting or replacing spend.

string

wait_for_confirmation

Present and true when mempool_policy is chain_too_long or truc.

boolean

claims_released

On a checkout or accept completion refused as mempool_rejected: the journaled settlement ended and every listing, bid, and asset claim it held was released (its inputs were proven unspent). The quote or accept is replaced; request a new one.

boolean

refused_listings

Batch listing routes only: every refused item. The first sets the status and code.

Array<object>

One refused item in a batch refusal’s refused_listings array. Nothing in the batch was changed.

object

index

required

integer

listing_id

required

string

status

required

integer

code

required

string

error

required

string

key

additional properties

any

retry_after_seconds

On 429 rate_limited: the exact seconds until the oldest counted request leaves the window; a retry then is admitted (also sent as Retry-After). Limited writes are bucketed per route scope in exact sliding 60-second windows: by session address when a valid x-session-token is present, otherwise by IP, with a per-IP ceiling across sessions. Expensive writes: 20, ceiling 120. Signed completions: 120, ceiling 600. Session minting (/auth/*): 60 per IP. A request refused by any bucket is counted by none.

integer

>= 1

key

additional properties

any

Example

{
  "code": "invalid_request",
  "mempool_policy": "fee_floor"
}

5XX

Stable machine-readable failure

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: invalid_request unsupported_address_type unauthenticated forbidden not_found method_not_allowed state_changed expired invalid_transaction rate_limited internal_error upstream_unavailable service_unavailable checkout_changed target_unavailable signature_invalid template_mismatch mempool_rejected broadcast_unknown conflict_spend duplicate_funding_slot offer_selection_unavailable attached_delivery_single_item_only insufficient_funds insufficient_asset_balance price_below_minimum listing_price_above_maximum counter_price_invalid self_trade offer_capacity_full open_offer_limit policy_offer_refused

retryable

boolean

mempool_policy

On 422 mempool_rejected from a broadcast: which deterministic node policy refused the bytes. Retrying the same bytes fails the same way. fee_floor: re-quote at a higher fee_rate. chain_too_long: too many unconfirmed ancestors; wait for a confirmation, then retry. truc: a version-3 (TRUC) package rule, such as spending an unconfirmed version-3 output; wait for a confirmation, then retry.

string

Allowed values: fee_floor chain_too_long truc dust nonstandard

mempool_reason

The node’s own reject reason, on mempool_rejected (422) and on state_changed (409) when a broadcast lost to a conflicting or replacing spend.

string

wait_for_confirmation

Present and true when mempool_policy is chain_too_long or truc.

boolean

claims_released

On a checkout or accept completion refused as mempool_rejected: the journaled settlement ended and every listing, bid, and asset claim it held was released (its inputs were proven unspent). The quote or accept is replaced; request a new one.

boolean

refused_listings

Batch listing routes only: every refused item. The first sets the status and code.

Array<object>

One refused item in a batch refusal’s refused_listings array. Nothing in the batch was changed.

object

index

required

integer

listing_id

required

string

status

required

integer

code

required

string

error

required

string

key

additional properties

any

retry_after_seconds

On 429 rate_limited: the exact seconds until the oldest counted request leaves the window; a retry then is admitted (also sent as Retry-After). Limited writes are bucketed per route scope in exact sliding 60-second windows: by session address when a valid x-session-token is present, otherwise by IP, with a per-IP ceiling across sessions. Expensive writes: 20, ceiling 120. Signed completions: 120, ceiling 600. Session minting (/auth/*): 60 per IP. A request refused by any bucket is counted by none.

integer

>= 1

key

additional properties

any

Example

{
  "code": "invalid_request",
  "mempool_policy": "fee_floor"
}