Skip to main content

Interface: IPayTransactionPayload

Passed to the callbacks when the payment is being broadcasted and confirmed

Properties

amount

Optional amount: string

Payment amount in ETH's or token's WEI

Defined in

typing/index.ts:646


amountArbitrator

Optional amountArbitrator: string

Amount (in ETH's or token's WEI) which the arbitrator would receive if the payment was claimed as is (amount * fee in this case)

Defined in

typing/index.ts:658


amountBuyer

Optional amountBuyer: string

Amount (in ETH's or token's WEI) which the buyer would receive if the payment was claimed as is (0 in this case)

Defined in

typing/index.ts:649


amountMarketplace

Optional amountMarketplace: string

Amount (in ETH's or token's WEI) which the marketplace would receive if the payment was claimed as is (amount * fee in this case)

Defined in

typing/index.ts:655


amountProtocol

Optional amountProtocol: string

Amount (in ETH's or token's WEI) which the protocol would receive if the payment was claimed as is (amount * fee in this case)

Defined in

typing/index.ts:661


amountSeller

Optional amountSeller: string

Amount (in ETH's or token's WEI) which the seller would receive if the payment was claimed as is (amount - fees in this case)

Defined in

typing/index.ts:652


arbitrator

Optional arbitrator: string

Arbitrator address (null if none)

Defined in

typing/index.ts:592


arbitratorFee

Optional arbitratorFee: number

Arbitrator fee specified in the payment (%, can be 0)

Defined in

typing/index.ts:586


blockNumber

Optional blockNumber: number

Number of the block in which the payment transaction was minted

Defined in

typing/index.ts:580


buyer

Optional buyer: string

Address of the buyer (who sent the payment)

Defined in

typing/index.ts:595


challengePeriod

Optional challengePeriod: number

Initial challenge period (seconds)

Defined in

typing/index.ts:601


challengePeriodEnd

Optional challengePeriodEnd: Date

When does the current challenge period end (paidAt + challengePeriod in this case)

Defined in

typing/index.ts:610


challengePeriodExtension

Optional challengePeriodExtension: number

By how much does the challenge period extend after each challenge

Defined in

typing/index.ts:604


challengePeriodStart

Optional challengePeriodStart: Date

When does the current challenge period start (same as paidAt in this case)

Defined in

typing/index.ts:607


claimed

Optional claimed: boolean

If the payment was claimed (always false here)

Defined in

typing/index.ts:625


consensusBuyer

Optional consensusBuyer: number

Buyer's consensus over the escrow (0 in this case)

Defined in

typing/index.ts:628


consensusSeller

Optional consensusSeller: number

Seller's consensus over the scrow (1 in this case)

Defined in

typing/index.ts:631


escrowId

Optional escrowId: number

Escrow Id generated by the contract (available only in confirmed callback)

Defined in

typing/index.ts:583


marketplace

Optional marketplace: string

Address of the marketplace that facilitated the payment (null if none)

Defined in

typing/index.ts:613


marketplaceFee

Optional marketplaceFee: number

Marketplace fee (%, can be 0 even if a marketplace was defined)

Defined in

typing/index.ts:616


name

Optional name: string

Name of the event ('Pay')

Defined in

typing/index.ts:577


paidAt

Optional paidAt: Date

When was the payment sent

Defined in

typing/index.ts:589


paymentReference

Optional paymentReference: string

A text reference that was attached to the payment

Defined in

typing/index.ts:622


seller

Optional seller: string

Address of the seller (whom is the payment for)

Defined in

typing/index.ts:598


splitBuyer

Optional splitBuyer: number

Buyer's split of the payment (0 in this case)

Defined in

typing/index.ts:634


splitMarketplace

Optional splitMarketplace: number

Marketplace fee (%)

Defined in

typing/index.ts:640


splitProtocol

Optional splitProtocol: number

Protocol fee (%)

Defined in

typing/index.ts:643


splitSeller

Optional splitSeller: number

Seller's split of the payment (100 in this case)

Defined in

typing/index.ts:637


tokenAddress

Optional tokenAddress: string

Token used in the payment (null for ETH)

Defined in

typing/index.ts:619


transactionHash

transactionHash: string

Defined in

typing/index.ts:574