GetPaymentOptions API Operation
Important: Adaptive Payments is not available for new integrations. PayPal provides this documentation to support existing integrations.
Shows the options previously specified in the SetPaymentOptions API.
GetPaymentOptionsRequest Message
GetPaymentOptionsRequest Fields
Field |
Description |
---|---|
|
(Required) The pay key that identifies the payment for which you want to get payment options. This is the pay key you used to set the payment options. |
|
(Required) Information common to each API operation, such as the language in which an error message is returned. |
RequestEnvelope Fields
Field |
Description |
---|---|
|
(Optional) Level of detail required by the client application for components. Value is:
|
|
(Required) RFC 3066 language in which error messages are returned; by default it is |
GetPaymentOptionsResponse Message
GetPaymentOptionsResponse Fields
Field |
Description |
---|---|
|
The pay key that identifies the payment for which you set payment options. |
|
Specifies display items in payment flows and emails. |
|
The PayPal financial partner that is initiating the payment. Financial partners must first be set up in the Admin tool before they can use the PayPal APIs. |
|
Sender's shipping address ID. |
|
Specifies information to be provided by the sender, and optionally can include the sender address. |
|
Specifies information about each receiver. |
|
Information common to each API operation, such as the language in which an error message is returned. |
DisplayOptions Fields
DisplayOptions fields allow the API caller to provide PayPal with a link to an image.
Field |
Description |
---|---|
|
The URL of the image that displays in the in the header of customer emails. The image dimensions are 43 pixels high x 240 pixels wide. |
|
The URL of the image that displays in the in customer emails. The image dimensions are 80 pixels high x 530 pixels wide. |
|
The URL of the image that displays in the header of a payment page. Use this to configure payment flows by passing a different image URL for different scenarios. If set, it overrides the header image URL specified in your account's Profile. The image dimensions are 90 pixels high x 750 pixels wide. Note: The |
|
The business name to display. Note: The |
InitiatingEntity Fields
Field |
Description |
---|---|
|
(Optional) Details about the party that initiated this payment. 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. |
Institution Customer Fields
Field |
Description |
---|---|
|
(Required) The two-character country code of the home country of the end consumer |
|
(Required) The full name of the consumer as known by the institution. Maximum length: 200 characters |
|
(Optional) The email address of the consumer as known by the institution. Maximum length: 127 characters |
|
(Required) The first name of the consumer as known by the institution. Maximum length: 64 characters |
|
(Required) The unique identifier assigned to the consumer by the institution. Maximum length: 64 characters |
|
(Required) The unique identifier assigned to the institution. Maximum length: 64 characters |
|
(Required) The last name of the consumer as known by the institution. Maximum length: 64 characters |
SenderOptions Fields
Field |
Description |
---|---|
|
(Optional) If |
|
(Optional) A code that identifies the partner associated with this transaction. Maximum length: 32 characters. |
|
(Optional) Determines whether pages in the user interface will enable the user to override the specified shipping address (that is, the address specified in the |
|
(Optional) Container for the sender's shipping address. After you specify an address using this container, the address will be returned as part of a PaymentDetails API response. |
ReceiverOptions Fields
Field |
Description |
---|---|
|
A description you want to associate with the payment. Maximum length: 1000 characters |
|
An external reference or identifier you want to associate with the payment. Maximum length: 1000 characters |
|
Item information for the payment, which could appear on an invoice. |
|
Receiver ID associated with these options. |
ShippingAddressInfo Fields
Field |
Description |
---|---|
|
(Optional) Person's name associated with this shipping address. Maximum length: 128 characters |
|
(Optional) First street address. Maximum length: 128 characters |
|
(Optional) Second street address. Maximum length: 128 characters |
|
(Optional) Name of city. Maximum length: 128 characters |
|
(Optional) State or province. Maximum length: 128 characters |
|
(Optional) U.S. ZIP code or other country-specific postal code. Maximum length: 128 characters |
|
(Optional) Country code. Maximum length: 128 characters |
|
(Optional) Phone number. |
PhoneNumber Fields
Field |
Description |
---|---|
|
(Optional) Specifies the type of phone number. Currently, only
|
InvoiceData Fields
Field |
Description |
---|---|
|
Any number of items associated with the payment. |
|
Total tax associated with the payment. |
|
Total shipping charge associated with the payment. |
InvoiceItem Fields
Field |
Description |
---|---|
|
Name of item. |
|
External reference to item or item ID. |
|
Price of item. |
|
Price of an individual item. |
|
Item quantity. |
ReceiverIdentifier Fields
Field |
Description |
---|---|
|
Receiver's email address. Maximum length: 127 characters |
|
Receiver's phone number. |
PhoneNumberType Response Fields
Field |
Description |
---|---|
|
Telephone country code. |
|
Telephone number. |
|
Telephone extension. |
ResponseEnvelope Fields
Field |
Description |
---|---|
|
Acknowledgment code. Value is:
|
|
Build number. It is used only by PayPal Merchant Technical Support. |
|
Correlation identifier. It is a 13-character, alphanumeric string (for example, Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
|
Date on which the response was sent, for example: Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
PPFault Message
The PPFaultMessage
returns ErrorData
and the ResponseEnvelope
information to your application if an error occurs.
FaultMessage Fields
Field |
Description |
---|---|
|
Detailed error information. |
|
Common response information, including a timestamp and the response acknowledgment status. |
ErrorData Fields
Field |
Description |
---|---|
|
The location where the error occurred. Value is:
|
|
The domain to which this service belongs. |
|
A 6-digit number that uniquely identifies a particular error. |
|
This field is not used. |
|
A description of the error. |
|
Represents contextual information about the error. |
|
The severity of the error encountered. Value is:
|
|
This field is not used. |
ResponseEnvelope Fields
Field |
Description |
---|---|
|
Acknowledgment code. Value is:
|
|
Build number. It is used only by PayPal Merchant Technical Support. |
|
Correlation identifier. It is a 13-character, alphanumeric string (for example, Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
|
Date on which the response was sent, for example: Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
GetPaymentOptions Errors
Code |
Message |
Additional Information |
---|---|---|
520002 | Internal error | |
520003 |
Authentication failed. API credentials are incorrect. |
Since 1.6.0 |
540031 |
You do not have permission to get these payment options |
|
540031 |
You do not have permission to get these payment options Operation is not permitted because the credentials do not match those of the initial operation |
Since 1.6.0 |
550001 |
User is not allowed to perform this action |
|
580001 | Invalid request: <value> |
Since 1.6.0 |
580022 |
Invalid request parameter: payKey with value <value> |
|