nodes/generated

Interface PayPalNodeParameters

Source


interface PayPalNodeParameters {
    additionalFields?: {
        emailMessage?: string;
        emailSubject?: string;
        note?: string;
    };
    itemsJson?: string;
    itemsUi?: {
        itemsValues: {
            amount: string;
            currency?: | "AUD"
            | "BRL"
            | "CAD"
            | "CZK"
            | "DKK"
            | "EUR"
            | "USD";
            note?: string;
            receiverValue: string;
            recipientType?: "email"
            | "phone"
            | "paypalId";
            recipientWallet?: "paypal" | "venmo";
            senderItemId?: string;
        }[];
    };
    jsonParameters?: boolean;
    limit?: number;
    operation?: "create"
    | "get"
    | "cancel";
    payoutBatchId?: string;
    payoutItemId?: string;
    resource?: "payout" | "payoutItem";
    returnAll?: boolean;
    senderBatchId?: string;
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

§readonly itemsJson?: string

An array of individual payout items Type options: {"alwaysOpenEditWindow":true}

§readonly itemsUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly jsonParameters?: boolean
§readonly limit?: number

Max number of results to return Default: 100 Type options: {"maxValue":1000,"minValue":1}

§readonly operation?: "create" | "get" | "cancel"

Default: "create"

§readonly payoutBatchId?: string

The ID of the payout for which to show details

§readonly payoutItemId?: string

The ID of the payout item for which to show details

§readonly resource?: "payout" | "payoutItem"

Default: "payout"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly senderBatchId?: string

A sender-specified ID number. Tracks the payout in an accounting system.