Skip to main content

Interface: ApproveSettlementParsedPayload

Escrow data sent after a settlement offer is approved and the payment is settled

Hierarchy​

Properties​

amount​

• amount: string

Amount in token

Defined in​

typing/index.ts:282

amountArbitrator​

• amountArbitrator: string

Arbitrator's final share in percentage incl. fees

Defined in​

typing/index.ts:292

amountBuyer​

• amountBuyer: string

Buyer's final share in percentage incl. fees

Defined in​

typing/index.ts:284

amountMarketplace​

• amountMarketplace: string

Marketplace's final share in percentage incl. fees

Defined in​

typing/index.ts:288

amountProtocol​

• amountProtocol: string

Protocol's final share in percentage incl. fees

Defined in​

typing/index.ts:290

amountSeller​

• amountSeller: string

Seller's final share in percentage incl. fees

Defined in​

typing/index.ts:286

blockNumber​

• blockNumber: number

Number of the block in which the transaction was minted

Inherited from​

GenericParsedTxPayload.blockNumber

Defined in​

typing/index.ts:222

buyer​

• buyer: string

Who sent the payment

Defined in​

typing/index.ts:250

challengePeriodEnd​

• challengePeriodEnd: Date

When does the current challenge period end (seconds in Unix epoch)

Defined in​

typing/index.ts:258

challengePeriodExtension​

• challengePeriodExtension: number

By how much will the challenge period get extended after a challenge (in seconds)

Defined in​

typing/index.ts:254

challengePeriodStart​

• challengePeriodStart: Date

When does the current challenge period start (seconds in Unix epoch)

Defined in​

typing/index.ts:256

claimed​

• claimed: boolean

True if the payment was already withdrawn from the escrow

Defined in​

typing/index.ts:268

consensusBuyer​

• consensusBuyer: number

Buyer's agreement on the arbitrator

Defined in​

typing/index.ts:270

consensusSeller​

• consensusSeller: number

Seller's agreement on the arbitrator

Defined in​

typing/index.ts:272

escrowId​

• escrowId: number

ID of the escrow that the transaction created or acted upon

Inherited from​

GenericParsedTxPayload.escrowId

Defined in​

typing/index.ts:224

latestSettlementOfferBuyer​

• latestSettlementOfferBuyer: number

How much was the buyer offered in the latest settlement offer

Defined in​

typing/index.ts:246

latestSettlementOfferSeller​

• latestSettlementOfferSeller: number

How much was the seller offered in the latest settlement offer

Defined in​

typing/index.ts:248

marketplace​

• marketplace: string

address of a marketplace that has facilitated the payment

Defined in​

typing/index.ts:260

marketplaceFee​

• marketplaceFee: number

Fee for the marketplace (can be 0 even if a marketplace was set but doesn't charge fee)

Defined in​

typing/index.ts:262

name​

• name: string

Name of the event

Inherited from​

GenericParsedTxPayload.name

Defined in​

typing/index.ts:218

paymentReference​

• Optional paymentReference: string

A text reference that was attached to the payment

Defined in​

typing/index.ts:266

seller​

• seller: string

Whom is the payment for

Defined in​

typing/index.ts:252

settledAt​

• settledAt: Date

Defined in​

typing/index.ts:244

splitBuyer​

• splitBuyer: number

Current buyer's split based on the latest action on the escrow

Defined in​

typing/index.ts:274

splitMarketplace​

• splitMarketplace: number

Marketplace fee (bips)

Defined in​

typing/index.ts:278

splitProtocol​

• splitProtocol: number

Protocol fee (bips)

Defined in​

typing/index.ts:280

splitSeller​

• splitSeller: number

Current seller's split based on the latest action on the escrow

Defined in​

typing/index.ts:276

tokenAddress​

• Optional tokenAddress: string

Token used in the payment (null for ETH)

Defined in​

typing/index.ts:264

transactionHash​

• transactionHash: string

Transaction hash

Inherited from​

GenericParsedTxPayload.transactionHash

Defined in​

typing/index.ts:220