Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ContractTerms

Contract terms from a merchant.

Hierarchy

  • ContractTerms

Index

Properties

amount

amount: string

Total amount payable.

auditors

auditors: AuditorHandle[]

Auditors accepted by the merchant.

Optional auto_refund

auto_refund: Duration

Hash of the merchant's wire details.

Optional delivery_date

delivery_date: Timestamp

Time indicating when the order should be delivered. May be overwritten by individual products.

Optional delivery_location

delivery_location: Location

Delivery location for (all!) products.

exchanges

exchanges: ExchangeHandle[]

List of accepted exchanges.

Optional extra

extra: any

Extra data, interpreted by the mechant only.

Optional fulfillment_message

fulfillment_message: string

Plain text fulfillment message in the merchant's default language.

Optional fulfillment_message_i18n

fulfillment_message_i18n: InternationalizedString

Internationalized fulfillment messages.

Optional fulfillment_url

fulfillment_url: string

Fulfillment URL to view the product or delivery status.

h_wire

h_wire: string

Hash of the merchant's wire details.

max_fee

max_fee: string

Maximum deposit fee covered by the merchant.

Optional max_wire_fee

max_wire_fee: string

Maximum wire fee that the merchant agrees to pay for.

merchant

merchant: MerchantInfo

Information about the merchant.

merchant_base_url

merchant_base_url: string

Base URL of the merchant's backend.

merchant_pub

merchant_pub: string

Public key of the merchant.

nonce

nonce: string

Nonce used to ensure freshness.

order_id

order_id: string

Order id to uniquely identify the purchase within one merchant instance.

pay_deadline

pay_deadline: Timestamp

Deadline to pay for the contract.

Optional products

products: Product[]

Products that are sold in this contract.

refund_deadline

refund_deadline: Timestamp

Deadline for refunds.

summary

summary: string

Human-readable short summary of the contract.

Optional summary_i18n

timestamp

timestamp: Timestamp

Time when the contract was generated by the merchant.

Optional wire_fee_amortization

wire_fee_amortization: number

Share of the wire fee that must be settled with one payment.

wire_method

wire_method: string

Wire method the merchant wants to use.

wire_transfer_deadline

wire_transfer_deadline: Timestamp

Deadline for the wire transfer.

Generated using TypeDoc