Skip to main content

Interface: IPaymentPropsData

Payment data input

Hierarchy

Properties

amount

amount: string | number | bigint

Amount in token

Inherited from

IPaymentProps.amount

Defined in

typing/index.ts:28


arbitrator

Optional arbitrator: string

Address of the arbitrator. null for no arbitrator

Inherited from

IPaymentProps.arbitrator

Defined in

typing/index.ts:40


arbitratorFee

Optional arbitratorFee: number

Arbitrator's fee in %. Can be 0

Inherited from

IPaymentProps.arbitratorFee

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

Inherited from

IPaymentProps.buyer

Defined in

typing/index.ts:46


callbackUrl

Optional callbackUrl: string

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

Inherited from

IPaymentProps.callbackUrl

Defined in

typing/index.ts:50


cancelUrl

Optional cancelUrl: string

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

Inherited from

IPaymentProps.cancelUrl

Defined in

typing/index.ts:48


challengePeriod

challengePeriod: number

Initial challenge period (in seconds)

Inherited from

IPaymentProps.challengePeriod

Defined in

typing/index.ts:32


challengePeriodExtension

Optional challengePeriodExtension: number

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

Inherited from

IPaymentProps.challengePeriodExtension

Defined in

typing/index.ts:34


ensAddresses

Optional ensAddresses: IEnsAddresses

Defined in

typing/index.ts:58


marketplace

Optional marketplace: string

address of a marketplace that has facilitated the payment

Inherited from

IPaymentProps.marketplace

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)

Inherited from

IPaymentProps.marketplaceFee

Defined in

typing/index.ts:38


paymentReference

Optional paymentReference: string

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

Inherited from

IPaymentProps.paymentReference

Defined in

typing/index.ts:44


seller

seller: string

Whom is the payment for

Inherited from

IPaymentProps.seller

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)

Inherited from

IPaymentProps.tokenAddress

Defined in

typing/index.ts:30