PaymentOptions Type
Details about the party that initiated this payment, as well as some display options.
Remarks
The following fields refer 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. All of the above fields except
Email are required when sending
a
SetPaymentOptions transaction.
Note: Financial partners must first be set up in the Admin tool before they can use
the PayPal APIs.
The remaining fields, HeaderImageURL and MarketingImageURL, are used to specify
images to be used for emails sent to customers.
Fields
| |
CountryCode
String |
The two-character country code of the home country of the end consumer.
This field is required.
This field 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.
|
CustomerId
String |
The unique identifier assigned to the consumer by the institution.
This field is required.
This field 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.
|
DisplayName
String |
The full name of the customer as known by the institution.
This field is required.
This field 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.
|
Email
String |
The email address of the consumer as known by the institution.
This field is optional.
This field 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.
|
FirstName
String |
The first name of the consumer as known by the institution.
This field is required.
This field 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.
|
HeaderImageURL
String |
The URL where the image is stored that appears in the header of customer emails.
The image dimensions are 43 pixels high x 240 pixels wide. This field is optional.
|
InstitutionId
String |
The unique identifier assigned to the institution.
This field is required.
This field 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.
|
LastName
String |
The last name of the consumer as known by the institution.
This field is required.
This field 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.
|
MarketingImageURL
String |
The URL where the marketing image is stored that appears in customer emails.
The image dimensions are 80 pixels high x 530 pixels wide. This field is optional.
|
Constructors
[VB.NET]
Public PaymentOptions()
[C#]
public PaymentOptions();