Skip to main content

Interface: IPaymentProps

Payment data input

Hierarchy​

Properties​

amount​

• amount: string | number | bigint

Amount in token

Defined in​

typing/index.ts:28

arbitrator​

• Optional arbitrator: string

Address of the arbitrator. null for no arbitrator

Defined in​

typing/index.ts:40

arbitratorFee​

• Optional arbitratorFee: number

Arbitrator's fee in %. Can be 0

Defined in​

typing/index.ts:42

buyer​

• Optional buyer: string

Who's the buyer, i.e. who can release the payment or whom should a refund be sent to. Leave empty to assign the user's wallet

Defined in​

typing/index.ts:46

callbackUrl​

• Optional callbackUrl: string

(UI only) A url to redirect to, when the payment is done

Defined in​

typing/index.ts:50

cancelUrl​

• Optional cancelUrl: string

(UI only) A url to redirect to, when the payment is canceled

Defined in​

typing/index.ts:48

challengePeriod​

• challengePeriod: number

Initial challenge period (in seconds)

Defined in​

typing/index.ts:32

challengePeriodExtension​

• Optional challengePeriodExtension: number

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

Defined in​

typing/index.ts:34

marketplace​

• Optional marketplace: string

address of a marketplace that has facilitated the payment

Defined in​

typing/index.ts:36

marketplaceFee​

• Optional marketplaceFee: number

Marketplace fee in % (can be 0 even if a marketplace was set but doesn't charge fee)

Defined in​

typing/index.ts:38

paymentReference​

• Optional paymentReference: string

A reference used to identify the payment or provide information for arbitration

Defined in​

typing/index.ts:44

seller​

• seller: string

Whom is the payment for

Defined in​

typing/index.ts:26

tokenAddress​

• Optional tokenAddress: string

Address of the token used in the payment (skip or set to null for ETH)

Defined in​

typing/index.ts:30