Interface PaymentDetails

The details of the payment options for the checkout flow.

interface PaymentDetails {
    defaultWrapAmount: {
        multiplier: number;
        period?: "day" | "week" | "month" | "year";
    };
    modifyFlowRateBehaviour: "ADD" | "SET" | "ENSURE";
    paymentOptions: {
        chainId: 1 | 42161 | 421613 | 43114 | 43113 | 8453 | 84531 | 56 | 42220 | 100 | 5 | 11155111 | 10 | 420 | 137 | 80001;
        flowRate?: {
            amountEther: `${number}`;
            period: "day" | "week" | "month" | "year";
        };
        receiverAddress: `0x${string}`;
        superToken: {
            address: `0x${string}`;
        };
        transferAmountEther?: `${number}`;
        userData?: `0x${string}`;
    }[];
}

Hierarchy

TypeOf<typeof paymentDetailsSchema>
- PaymentDetails

Index

Properties

defaultWrapAmount modifyFlowRateBehaviour paymentOptions

Properties

defaultWrapAmount

defaultWrapAmount: {
multiplier: number;
period?: "day" | "week" | "month" | "year";
} = ...

Type declaration

multiplier: number
Optional period?: "day" | "week" | "month" | "year"

modifyFlowRateBehaviour

modifyFlowRateBehaviour: "ADD" | "SET" | "ENSURE" = modifyFlowRateBehaviourSchema

paymentOptions

paymentOptions: {
    chainId: 1 | 42161 | 421613 | 43114 | 43113 | 8453 | 84531 | 56 | 42220 | 100 | 5 | 11155111 | 10 | 420 | 137 | 80001;
    flowRate?: {
        amountEther: `${number}`;
        period: "day" | "week" | "month" | "year";
    };
    receiverAddress: `0x${string}`;
    superToken: {
        address: `0x${string}`;
    };
    transferAmountEther?: `${number}`;
    userData?: `0x${string}`;
}[] = ...

Type declaration

chainId: 1 | 42161 | 421613 | 43114 | 43113 | 8453 | 84531 | 56 | 42220 | 100 | 5 | 11155111 | 10 | 420 | 137 | 80001
Optional flowRate?: {
amountEther: `${number}`;
period: "day" | "week" | "month" | "year";
}
- amountEther: `${number}`
- period: "day" | "week" | "month" | "year"
receiverAddress: `0x${string}`
superToken: {
address: `0x${string}`;
}
- address: `0x${string}`
Optional transferAmountEther?: `${number}`
Optional userData?: `0x${string}`

Interface PaymentDetails

Hierarchy

Index

Properties

Properties

defaultWrapAmount

Type declaration

multiplier: number

`Optional` period?: "day" | "week" | "month" | "year"

modifyFlowRateBehaviour

paymentOptions

Type declaration

chainId: 1 | 42161 | 421613 | 43114 | 43113 | 8453 | 84531 | 56 | 42220 | 100 | 5 | 11155111 | 10 | 420 | 137 | 80001

`Optional` flowRate?: {
amountEther: `${number}`;
period: "day" | "week" | "month" | "year";
}

amountEther: `${number}`

period: "day" | "week" | "month" | "year"

receiverAddress: `0x${string}`

superToken: {
address: `0x${string}`;
}

address: `0x${string}`

`Optional` transferAmountEther?: `${number}`

`Optional` userData?: `0x${string}`

Settings

Member Visibility

Theme

On This Page

Interface PaymentDetails

Hierarchy

Index

Properties

Properties

defaultWrapAmount

Type declaration

multiplier: number

Optional period?: "day" | "week" | "month" | "year"

modifyFlowRateBehaviour

paymentOptions

Type declaration

chainId: 1 | 42161 | 421613 | 43114 | 43113 | 8453 | 84531 | 56 | 42220 | 100 | 5 | 11155111 | 10 | 420 | 137 | 80001

Optional flowRate?: { amountEther: `${number}`; period: "day" | "week" | "month" | "year"; }

amountEther: `${number}`

period: "day" | "week" | "month" | "year"

receiverAddress: `0x${string}`

superToken: { address: `0x${string}`; }

address: `0x${string}`

Optional transferAmountEther?: `${number}`

Optional userData?: `0x${string}`

Settings

Member Visibility

Theme

On This Page

`Optional` period?: "day" | "week" | "month" | "year"

`Optional` flowRate?: {
amountEther: `${number}`;
period: "day" | "week" | "month" | "year";
}

superToken: {
address: `0x${string}`;
}

`Optional` transferAmountEther?: `${number}`

`Optional` userData?: `0x${string}`