Interface: IPaymentProps
Payment data input
Hierarchy
-
IPaymentProps
Properties
amount
• amount: string | number | bigint
Amount in token
Defined in
typing/index.ts:27
arbitrator
• Optional arbitrator: string
Address of the arbitrator. null for no arbitrator
Defined in
typing/index.ts:39
arbitratorFee
• Optional arbitratorFee: number
Arbitrator's fee in %. Can be 0
Defined in
typing/index.ts:41
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:45
callbackUrl
• Optional callbackUrl: string
(UI only) A url to redirect to, when the payment is done
Defined in
typing/index.ts:49
cancelUrl
• Optional cancelUrl: string
(UI only) A url to redirect to, when the payment is canceled
Defined in
typing/index.ts:47
challengePeriod
• challengePeriod: number
Initial challenge period (in seconds)
Defined in
typing/index.ts:31
challengePeriodExtension
• Optional challengePeriodExtension: number
By how much will the challenge period get extended after a challenge (in seconds)
Defined in
typing/index.ts:33
marketplace
• Optional marketplace: string
address of a marketplace that has facilitated the payment
Defined in
typing/index.ts:35
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:37
paymentReference
• Optional paymentReference: string
A reference used to identify the payment or provide information for arbitration
Defined in
typing/index.ts:43
seller
• seller: string
Whom is the payment for
Defined in
typing/index.ts:25
tokenAddress
• Optional tokenAddress: string
Address of the token used in the payment (skip or set to null for ETH)
Defined in
typing/index.ts:29