Interface WiseNodeParameters

Source
interface WiseNodeParameters {
    additionalFields?:
        | {
            lineStyle?: "COMPACT"
            | "FLAT";
            range?: {
                rangeProperties: {
                    intervalEnd?: string;
                    intervalStart?: string;
                };
            };
        }
        | {
            interval?: "hour"
            | "day"
            | "minute";
            range?: {
                rangeProperties: { from?: string; to?: string };
            };
            time?: string;
        }
        | { reference?: string };
    amount?: number;
    amountType?: "source" | "target";
    binaryProperty?: string;
    borderlessAccountId?: string;
    currency?: string;
    downloadReceipt?: boolean;
    fileName?: string;
    filters?: {
        range?: {
            rangeProperties: {
                createdDateEnd?: string;
                createdDateStart?: string;
            };
        };
        sourceCurrency?: string;
        status?: | "cancelled"
        | "unknown"
        | "bounced_back"
        | "charged_back"
        | "funds_converted"
        | "funds_refunded"
        | "incoming_payment_waiting"
        | "outgoing_payment_sent"
        | "processing"
        | "waiting_recipient_input_to_proceed";
        targetCurrency?: string;
    };
    format?: "json"
    | "pdf"
    | "csv"
    | "xml";
    limit?: number;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "delete"
        | "execute"
        | "getBalances"
        | "getCurrencies"
        | "getStatement";
    profileId?: string;
    quoteId?: string;
    resource?: | "account"
    | "profile"
    | "quote"
    | "exchangeRate"
    | "recipient"
    | "transfer";
    returnAll?: boolean;
    source?: string;
    sourceCurrency?: string;
    target?: string;
    targetAccountId?: string;
    targetCurrency?: string;
    transferId?: string;
}

Properties§

Source§

readonly additionalFields?:
    | {
        lineStyle?: "COMPACT"
        | "FLAT";
        range?: {
            rangeProperties: {
                intervalEnd?: string;
                intervalStart?: string;
            };
        };
    }
    | {
        interval?: "hour"
        | "day"
        | "minute";
        range?: {
            rangeProperties: { from?: string; to?: string };
        };
        time?: string;
    }
    | { reference?: string }

Default: {}

Source§

readonly amount?: number

Amount of funds for the quote to create Default: 1 Type options: {"minValue":1}

Source§

readonly amountType?: "source" | "target"

Whether the amount is to be sent or received Default: "source"

Source§

readonly binaryProperty?: string

Default: "data"

Source§

readonly borderlessAccountId?: string

ID of the borderless account to retrieve the statement of. Choose from the list, or specify an ID using an expression. Default: [] Type options: {"loadOptionsMethod":"getBorderlessAccounts","loadOptionsDependsOn":["profileId"]}

Source§

readonly currency?: string

Code of the currency of the borderless account to retrieve the statement of

Source§

readonly downloadReceipt?: boolean

Whether to download the transfer receipt as a PDF file. Only for executed transfers, having status 'Outgoing Payment Sent'.

Source§

readonly fileName?: string

Name of the file that will be downloaded

Source§

readonly filters?: {
    range?: {
        rangeProperties: {
            createdDateEnd?: string;
            createdDateStart?: string;
        };
    };
    sourceCurrency?: string;
    status?: | "cancelled"
    | "unknown"
    | "bounced_back"
    | "charged_back"
    | "funds_converted"
    | "funds_refunded"
    | "incoming_payment_waiting"
    | "outgoing_payment_sent"
    | "processing"
    | "waiting_recipient_input_to_proceed";
    targetCurrency?: string;
}

Default: {}

Source§

readonly format?: "json" | "pdf" | "csv" | "xml"

File format to retrieve the statement in Default: "json"

Source§

readonly limit?: number

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

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "delete"
    | "execute"
    | "getBalances"
    | "getCurrencies"
    | "getStatement"

Default: "getBalances"

Source§

readonly profileId?: string

ID of the user profile to retrieve the balance of. Choose from the list, or specify an ID using an expression. Default: [] Type options: {"loadOptionsMethod":"getProfiles"}

Source§

readonly quoteId?: string

ID of the quote to retrieve

Source§

readonly resource?:
    | "account"
    | "profile"
    | "quote"
    | "exchangeRate"
    | "recipient"
    | "transfer"

Default: "account"

Source§

readonly returnAll?: boolean

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

Source§

readonly source?: string

Code of the source currency to retrieve the exchange rate for

Source§

readonly sourceCurrency?: string

Code of the currency to send for the quote to create

Source§

readonly target?: string

Code of the target currency to retrieve the exchange rate for

Source§

readonly targetAccountId?: string

ID of the account that will receive the funds. Choose from the list, or specify an ID using an expression. Default: [] Type options: {"loadOptionsMethod":"getRecipients"}

Source§

readonly targetCurrency?: string

Code of the currency to receive for the quote to create

Source§

readonly transferId?: string

ID of the transfer to delete