LoadInputFile Method

Load mass payment file.

Syntax

masspay.loadInputFile(filename, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The PayPal website has a Mass Payment feature which takes a simple tab-delimited text file. This method will load this file into the RecipientEmail, Amount, CurrencyCode, TransactionId, and Note properties. The format of this file should be:

RecipientEmail [tab] Amount [tab] CurrencyCode [tab] TransactionId [tab] Note [crlf]

The TransactionId and Note properties are optional, but the rest are required. If you're not using these properties, either of the following formats are valid:

RecipientEmail [tab] Amount [tab] CurrencyCode [tab] [tab] [crlf]

RecipientEmail [tab] Amount [tab] CurrencyCode [crlf]