GetPrePaymentDisclosure API Operation
Important: Adaptive Payments is not available for new integrations. PayPal provides this documentation to support existing integrations.
Shows the pre-payment disclosure and response. This API is specific for merchants who must support the Consumer Financial Protection Bureau's Remittance Transfer Rule.
GetPrePaymentDisclosure Message
GetPrePaymentDisclosureRequest Fields
Field |
Description |
---|---|
|
(Required) The pay key that identifies the payment for which you want to retrieve details. This is the pay key returned in the pay response message. |
|
(Optional) List of payment receivers for unilateral scenarios. The list can contain details for a single simple payment or multiple receivers in support of parallel/chained payments. |
|
(Required) Information common to each API operation, such as the language in which an error message is returned. |
ReceiverInfoList Field
This must be provided in the case of a unilateral scenario.
Field |
Description |
---|---|
|
(Required) List of receiver information details. For multiple receivers, this supports parallel/chained payments. |
ReceiverInfo Fields
These fields must be populated for a receiver who does not have a PayPal account.
Field |
Description |
---|---|
|
(Required) Identifies the payment receiver. |
|
(Required) The two-character country code of the end consumer's home country. |
|
(Optional) The first name of the consumer as known by the institution. Maximum length: 64 characters |
|
(Optional) The last name of the consumer as known by the institution. Maximum length: 64 characters |
RequestEnvelope Fields
Field |
Description |
---|---|
|
(Optional) Level of detail required by the client application for components. Currently only one value is available:
|
|
(Required) RFC 3066 language in which error messages are returned; by default it is |
GetPrePaymentDisclosure Response
GetPrePaymentDisclosureResponse Fields
Field |
Description |
---|---|
|
(Optional) Holds the disclaimer. |
feesPayer |
xs:string
(Optional) The payer of PayPal fees. Value is:
|
|
(Optional) Holds the disclosure information related to receivers. The merchant can parse the details available in the response and display them to the receiver. |
responseEnvelope |
common:ResponseEnvelope
(Required) Common response information, including a timestamp and the response acknowledgment status. |
|
(Optional) Holds the disclosure related to the sender. Merchants should display the details in SenderDisclosure.
|
|
(Required) Indicates the response status:
|
ResponseEnvelope Fields
Field |
Description |
---|---|
|
(Required) acknowledgment code. Value is:
|
|
(Required) Build number. It is used only by PayPal Merchant Technical Support. |
|
(Required) 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. |
|
(Required) 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. |
SenderDisclosure Fields
Field |
Description |
---|---|
|
(Required) The amount of the transaction. |
|
(Required) The conversion rate from the sender currency to the transaction currency. Note: In the case when there is no conversion of the sender currency, none of the elements in the conversion rate tag are returned. |
|
(Optional) The fee, if any, associated with the transaction. |
|
(Required) The total transaction that includes the main transaction amount adjusted for any associated fee. |
Status Field
Field |
Description |
---|---|
|
(Required) Indicates the response status as one of the following:
|
ReceiverDisclosureList Field
Field |
Description |
---|---|
|
(Required) List of the disclosures for the receivers. |
ReceiverDisclosure Fields
Field |
Description |
---|---|
|
(Required) Identifies the payment receiver. |
|
(Required) The amount received from the sender. |
|
Note: The conversion rate in the receiver disclosure is obsolete. All the elements in this tag return NULL value. |
|
(Required) The two-character country code of the end consumer's home country. |
|
(Optional) The fee, if any, associated with the transaction. |
|
(Required) The total transaction that includes the main transaction amount adjusted for any associated fee. |
CurrencyType Fields
Field |
Description |
---|---|
|
(Required) The converted amount. |
|
(Required) The currency code for the converted amount. Value is:
|
ConversionRate Fields
Field |
Description |
---|---|
|
(Required) The exchange rate that converts a unit of the sender's currency to the transaction currency. |
|
(Required) The transaction currency that the receiver will receive. |
|
(Required) The sender's primary currency to be converted. |
FeeDisclosure Fields
Field |
Description |
---|---|
|
(Required) The fee associated with the payment. |
|
(Required) Taxes associated with the payment. |
PPFault Message
The PPFaultMessage
returns ErrorData
and the ResponseEnvelope
information to your application if an error occurs.
FaultMessage Fields
Field |
Description |
---|---|
|
(Optional) Detailed error information. |
|
(Required) 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. |
|
(Optional) This field is not used. |
|
A description of the error. |
|
(Optional) Represents contextual information about the error. |
|
The severity of the error encountered. Value is:
|
|
(Optional) This field is not used. |
ResponseEnvelope Fields
Field |
Description |
---|---|
|
(Required) acknowledgment code. Value is:
|
|
(Required) Build number. It is used only by PayPal Merchant Technical Support. |
|
(Required) 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. |
|
(Required) 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. |
GetPrePaymentDisclosure Errors
Code |
Message |
---|---|
520002 | Internal error. |
520003 |
Authentication failed. API credentials are incorrect. |
550001 |
User is not allowed to perform this action. |
569020 |
Feature not enabled. |
580001 |
Invalid request: <value> |
580022 | Invalid request parameter: <value> |
580023 |
The fee payer SENDER cannot be used with unilateral receiver |
580027 |
The parameter is not supported. |