FailedInitialAmountAction Property

The action to take when the initial amount is not paid.

Syntax

 recurringpayments.getFailedInitialAmountAction([callback])
 recurringpayments.setFailedInitialAmountAction( failedInitialAmountAction, [callback])

Default Value

""

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 the getFailedInitialAmountAction([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setFailedInitialAmountAction([callback]) 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

By default, this property is set to Cancel which will tell PayPal to create the current profile, but place it in a pending status until the initial amount transaction completes. If the transaction fails, the account profile will be canceled. Success or failure will result in an IPN notification from PayPal.

Alternatively, you may set this to Continue, which means that PayPal will not fail when the initial amount is not paid, but instead will add this amount to the OutstandingBalance for the profile.

Data Type

String