Pay Method

Creates and executes a new payment.

Syntax

adaptivepay.pay([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

To make a payment, set at least one Recipients (RecipientEmail and RecipientAmount), the CurrencyCode, CancelURL, and ReturnURL, and then call Pay. To make a parallel payment, set multiple Recipients and to make a chained payment make one (and only one) of the Recipients primary by setting the RecipientPrimary property to True.

For implicit approval, set the SenderEmail property. If you have a Preapproval set up, you can use the preapproval to avoid explicit approval. In that case set the PreApprovalKey and PreApprovalPIN properties instead.

If you need to change any default payment settings, use the CreatePayment method instead. Pass the PaymentKey you receive to the SetPaymentOptions method to update the default payment settings for that transaction. Then call ExecutePayment once you're ready to fulfill the payment.