Skip to main content

Interface: PayParsedPayload

Escrow data returned after the payment was sent and the escrow was created

Hierarchy​

Properties​

amount​

• amount: string

Amount in token

Defined in​

typing/index.ts:463

amountArbitrator​

• amountArbitrator: string

Current arbitrator feee (in ETH or token) based on the latest status of the escrow

Defined in​

typing/index.ts:471

amountBuyer​

• amountBuyer: string

Current buyer's share (in ETH or token) based on the latest status of the escrow

Defined in​

typing/index.ts:465

amountMarketplace​

• amountMarketplace: string

Current marketplace feee (in ETH or token) based on the latest status of the escrow

Defined in​

typing/index.ts:469

amountProtocol​

• amountProtocol: string

Current protocol feee (in ETH or token) based on the latest status of the escrow

Defined in​

typing/index.ts:473

amountSeller​

• amountSeller: string

Current seller's share (in ETH or token) based on the latest status of the escrow

Defined in​

typing/index.ts:467

arbitrator​

• arbitrator: string

Address of the arbitrator (null if none)

Defined in​

typing/index.ts:427

arbitratorFee​

• arbitratorFee: number

Arbitrator's fee (%, can be 0)

Defined in​

typing/index.ts:429

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:431

challengePeriod​

• challengePeriod: number

Initial challenge period (in seconds)

Defined in​

typing/index.ts:435

challengePeriodEnd​

• challengePeriodEnd: Date

When does the current challenge period end

Defined in​

typing/index.ts:441

challengePeriodExtension​

• challengePeriodExtension: number

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

Defined in​

typing/index.ts:437

challengePeriodStart​

• challengePeriodStart: Date

When does the current challenge period start

Defined in​

typing/index.ts:439

claimed​

• claimed: boolean

True if the payment was already withdrawn from the escrow

Defined in​

typing/index.ts:449

consensusBuyer​

• consensusBuyer: number

Buyer's agreement on the arbitrator

Defined in​

typing/index.ts:451

consensusSeller​

• consensusSeller: number

Seller's agreement on the arbitrator

Defined in​

typing/index.ts:453

escrowId​

• escrowId: number

ID of the escrow that the transaction created or acted upon

Inherited from​

GenericParsedTxPayload.escrowId

Defined in​

typing/index.ts:224

marketplace​

• marketplace: string

Address of a marketplace that has facilitated the payment

Defined in​

typing/index.ts:443

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:445

name​

• name: string

Name of the event

Inherited from​

GenericParsedTxPayload.name

Defined in​

typing/index.ts:218

paidAt​

• paidAt: Date

Date/time of the payment

Defined in​

typing/index.ts:425

paymentReference​

• Optional paymentReference: string

A text reference that was attached to the payment

Defined in​

typing/index.ts:475

seller​

• seller: string

Whom is the payment for

Defined in​

typing/index.ts:433

splitBuyer​

• splitBuyer: number

Buyer's split of the escrow (0 by default)

Defined in​

typing/index.ts:455

splitMarketplace​

• splitMarketplace: number

Marketplace fee (%)

Defined in​

typing/index.ts:459

splitProtocol​

• splitProtocol: number

Protocol fee (%)

Defined in​

typing/index.ts:461

splitSeller​

• splitSeller: number

Seller's split of the escrow (100 by default)

Defined in​

typing/index.ts:457

tokenAddress​

• Optional tokenAddress: string

Token used in the payment (null for ETH)

Defined in​

typing/index.ts:447

transactionHash​

• transactionHash: string

Transaction hash

Inherited from​

GenericParsedTxPayload.transactionHash

Defined in​

typing/index.ts:220