AckCodeType This code identifies the
acknowledgment code types that could be used to
communicate the status of processing a (request)
message to an application. This code would be
used as part of a response message that contains
an application level acknowledgment element.
Request processing succeeded.
Request processing failed.
Request processing completed with
warning information being included in
the response message.
Request processing completed successful
with some with some warning information
that could be useful for the requesting
application to process and/or record.
Request processing failed with some
error and warning information that
requesting application should process to
determine cause(s) of failure.
Details about the end user of the application
invoking this service.
DetailLevelCodeType
Return in response message all detail
levels.
This type contains the detailed error
information resulting from the service
operation.
This specifies a fault, encapsulating error
data, with specific error codes.
This specifies the list of parameters with every
request to the service.
This specifies the required detail level
that is needed by a client application
pertaining to a particular data
component (e.g., Item, Transaction,
etc.). The detail level is specified in
the DetailLevelCodeType which has all
the enumerated values of the detail
level for each component.
This should be the standard RFC 3066
language identification tag, e.g.,
en_US.
This specifies a list of parameters with every
response from a service.
Application level acknowledgment code.
A list of ISO currency codes.
A list of estimated currency conversions for a
base currency.
A table that contains a list of estimated
currency conversions for a base currency in each
row.
A list of ISO currencies.
Customizable options that a client application
can specify for display purposes.
FundingTypeInfo represents one allowed funding
type.
ShippingAddressInfo.
Describes the conversion between 2 currencies.
Funding source information.
Amount to be charged to a particular funding
source.
FundingPlan describes the funding sources to be
used for a specific payment.
Details about the party that initiated this
payment. The API user is making this payment on
behalf of the initiator. The initiator can
simply be an institution or a customer of the
institution.
The customer of the initiating institution
The unique identifier as assigned to the
institution.
The first (given) name of the end
consumer as known by the institution.
The last (family) name of the end
consumer as known by the institution.
The full name of the end consumer as
known by the institution.
The unique identifier as assigned to the
end consumer by the institution.
The two-character ISO country code of
the home country of the end consumer
Describes an individual item for an invoice.
Describes a payment for a particular receiver
(merchant), contains list of additional per item
details.
The error that resulted from an attempt to make
a payment to a receiver.
PaymentInfo represents the payment attempt made
to a Receiver of a PayRequest. If the execution
of the payment has not yet completed, there will
not be any transaction details.
Receiver is the party where funds are
transferred to. A primary receiver receives a
payment directly from the sender in a chained
split payment. A primary receiver should not be
specified when making a single or parallel split
payment.
The sender identifier type contains information
to identify a PayPal account.
Options that apply to the receiver of a payment,
allows setting additional details for payment
using invoice.
RefundInfo represents the refund attempt made to
a Receiver of a PayRequest.
Options that apply to the sender of a payment.
Require the user to select a shipping
address during the web flow.
Determines whether or not the UI pages should display the shipping address
set by user in this SetPaymentOptions request.
Details about the payer's tax info passed in by the merchant or partner.
Tax id of the merchant/business.
Tax type of the Tax Id.
The sender identifier type contains information
to identify a PayPal account.
This type contains the detailed warning
information resulting from the service
operation.
The request to cancel a Preapproval.
The result of the CancelPreapprovalRequest.
The request to confirm a Preapproval.
The result of the ConfirmPreapprovalRequest.
A request to convert one or more currencies into
their estimated values in other currencies.
The two-character ISO country code where
fx suppposed to happen
A response that contains a table of estimated
converted currencies based on the Convert
Currency Request.
The request to execute the payment request.
Describes the action that is performed
by this API
Contains information related to State Regulatory Agency Information of the Sender's country for RTR transaction
This contains
1.Agency Name
2.Phone Number
3.Website
Contains information related to Post Payment Disclosure Details
This contains
1.Receivers information
2.Funds Avalibility Date
3.State Regulatory Agency Information
The result of a payment execution.
The request to get the allowed funding sources
available for a preapproval.
The response to get the backup funding sources
available for a preapproval.
The request to get the options of a payment
request.
The response message for the GetPaymentOption
request
The request to look up the details of a
PayRequest. The PaymentDetailsRequest can be
made with either a payKey, trackingId, or a
transactionId of the PayRequest.
The details of the PayRequest as specified in
the Pay operation.
The PayRequest contains the payment instructions
to make from sender to receivers.
The pay key expires after the duration specified in this column.
If not provided, it defaults to normal expiration behavior.
Valid values are 5 minutes to 30 days.
The PayResponse contains the result of the Pay
operation. The payKey and execution status of
the request should always be provided.
The request to look up the details of a
Preapproval.
The details of the Preapproval as specified in
the Preapproval operation.
A request to create a Preapproval. A Preapproval
is an agreement between a Paypal account holder
(the sender) and the API caller (the service
invoker) to make payment(s) on the the sender's
behalf with various limitations defined.
The result of the PreapprovalRequest is a
preapprovalKey.
A request to make a refund based on various
criteria. A refund can be made against the
entire payKey, an individual transaction
belonging to a payKey, a tracking id, or a
specific receiver of a payKey.
The result of a Refund request.
Phone number with Type of phone number
The request to set the options of a payment
request.
The response message for the SetPaymentOption
request
The request to get the funding plans available
for a payment.
The response to get the funding plans available
for a payment.
The request to get the addresses available for a
payment.
The key for which to provide the
available addresses. Key can be an
AdaptivePayments key such as payKey or
preapprovalKey
The response to get the shipping addresses
available for a payment.
The request to get the addresses available for a
payment.
The key for which to provide the
available addresses. Key can be an
AdaptivePayments key such as payKey or
preapprovalKey
The response to get the shipping addresses
available for a payment.
The request to get the remaining limits for a
user
The account identifier for the user
List of limit types
A response that contains a list of remaining
limits
ReceiverInfo needs to be populate for the receiver who doesn't have paypal account.
The two-character ISO country code of
the home country of the Receiver
FeeDisclosure contains the information related to Fees and taxes.
SenderDisclosure contains the disclosure related to Sender
This holds the conversion rate from "Sender currency for one bucks to equivalent
value in the receivers currency"
ReceiverDisclosure contains the disclosure related to Receiver/Receivers.
The two-character ISO country code of
the home country of the Receiver
GetPrePaymentDisclosureRequest is used to get the PrePayment Disclosure.;
GetPrePaymentDisclosureRequest contains following parameters
payKey :The pay key that identifies the payment for which you want to retrieve details. this is the pay key returned in the PayResponse message.
receiverInfoList : This is an optional.This needs to be provided in case of Unilateral scenario.
receiverInfoList has a list of ReceiverInfo type. List is provided here to support in future for Parallel/Chained Payemnts.
Each ReceiverInfo has following variables
firstName : firstName of recipient.
lastName : lastName of recipient.
countryCode : CountryCode of Recipient.
GetPrePaymentDisclosureResponse contains the information related to PrePayment disclosure.
status : indicates the status of response.
If Status = RTR then it means that this is RTR transaction.
If Status = NON_RTR then it means that this is non RTR transaction.
If Status = MISSING_RECEIVER_COUNTRY_INFORMATION then it means the Receiver country information is not found in PayPal database.
So merchant has to call the API again with same set of parameter along with Receiver country code.This is useful in case of Unilateral scenario.
where receiver is not holding paypal account. This is currently a place holder to support backward compatibility since first name and last name are mandated too.
feePayer:Indicates who has agreed to Pay a Fee for the RTR transaction. Merchant can use this information to decide who actually has to pay the fee .
senderDisclosure : This Variable Holds the disclosure related to sender.
receiverDisclosureList : This list contains the disclosure information related to receivers.
Merchant can just parse the details what ever is avaliable in the response and display the same to user.