PaymentOptionsInstitutionId Property

The unique identifier assigned to the institution.

Syntax

 adaptivepay.getPaymentOptionsInstitutionId([callback])
 adaptivepay.setPaymentOptionsInstitutionId( paymentOptionsInstitutionId, [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 getPaymentOptionsInstitutionId([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 setPaymentOptionsInstitutionId([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

The unique identifier assigned to the institution. This property is required.

This property to the PayPal financial partner that is initiating the payment, and indicates that this payment is made by the API caller on behalf of the initiating party. The initiating party can be an institution or a customer of the institution. The initiating party must be set up by PayPal Merchant Services.

Note: Financial partners must first be set up in the Admin tool before they can use the PayPal APIs.

Data Type

String