Notice of non-liability:
PayPal, Inc. is providing the information in this document to you “AS-IS” with all faults. PayPal, Inc. makes no warranties of any kind (whether express,
implied or statutory) with respect to the information contained herein. PayPal, Inc. assumes no liability for damages (whether direct or indirect), caused
by errors or omissions, or resulting from the use of this document or the information contained in this document or resulting from the application or use
of the product or service described herein. PayPal, Inc. reserves the right to make changes to any information herein without further notice.
The Mobile Checkout Developer Guide describes the PayPal Mobile Checkout service. It
describes the interfaces, information flows, and functionality of this service.
Intended Audience
This guide is written for developers of mobile applications that use PayPal. You should be
familiar with mobile website programming and with either the PayPal Web Services API or
the PayPal Name-Value Pair API Interface.
Revision History
Revision history for Mobile Checkout Developer Guide.
TABLE P.1 Revision History
DateDescription
October 2009Updated the list of supported currencies and currency codes.
May 2008Added general API error codes.
September 2007
May 2007Initial version of document.
z Added information about secure Return and Cancel URLs
z Noted that PIN is recommended but not required.
Where to Go for More Information
This guide relies on information in the following guides and references:
z Express Checkout Integration Guide
z Name-Value Pair API Developer Guide
z SOAP API Developer Reference
z Sandbox User Guide
Mobile Checkout Developer GuideOctober 20095
6October 2009Mobile Checkout Developer Guide
1
PayPal Mobile Checkout
Overview
PayPal Mobile Checkout provides merchants with the essential components necessary for
mobile commerce:
z A hosted quick buyer flow
z A straightforward merchant interface
z Transaction completion data
z PayPal merchant support
PayPal defines mobile commerce as any and all transactions completed using a mobile phone.
Buyers use a simple two step process (login and review) to make payments. The merchant
interface can be plugged into any mobile medium that can initiate a mobile browser session,
and uses either the PayPal Web Services SOAP or Name/Value Pair (NVP) API interface.
After a transaction is completed, the necessary buyer and transaction data is delivered to the
merchant via the interface.
The processing flow and APIs for Mobile Checkout are similar to those for Express Checkout.
For more information about Express Checkout, see the Name-Value Pair (NVP) Developer Guide and Reference and the SOAP API Reference.
Security on the Mobile Web
PayPal Mobile Checkout is designed to support the vast majority of mobile devices sold by
major carriers that can make secure connections. To access mobile checkout, a device, mobile
carrier, and browser must support the following:
z WAP 2.0 phones (not WAP 1.0)
z xHTML or HTML markup language
z SSL connections
z Cookies enabled
z No carrier "WAP gap"
If a device or connection fails any of the these checks, the customer will not be able to connect
to the PayPal servers.
N OTE: Mobile web generally refers to the collection of accepted web standards used on
mobile devices. Most modern mobile devices use mini-browsers, much like a web
browser on a computer. A growing portion of phone subscribers pay for data plans to
access information, services, and commerce on their mobile devices though these
mobile browers. Most mobile browsers use the xHTML markup language, while
others also use cHTML, HTML, and WML. Most devices support cookies with default
Mobile Checkout Developer GuideOctober 20097
PayPal Mobile Checkout Overview
1
How Mobile Checkout Works
on and support SSL connections. However, not all devices meet these standards or
have implemented these standards to the associated specification.
How Mobile Checkout Works
1. After selecting products to purchase, your customers click a Checkout with PayPal link or
button on your mobile site or in a Short Message Service (SMS) text message.
2. They are transferred to PayPal, where they log in, review and select their payment method
and the correct shipping address.
3. The customer is returned to your mobile site to complete the transaction. PayPal returns to
you the shipping address, email, and other customer information needed to fulfill the order.
Availability
Only authorized business and premier merchants have access to the Mobile Checkout API. For
more information, contact your PayPal Account Manager.
Customer Activation for Mobile Checkout
Because numeric characters are easier to enter on a phone than an alphanumeric password, the
PayPal Mobile Checkout flow encourages customers to create a numeric PIN to use for future
transactions. The process of creating a numeric PIN is known as activation. In the checkout
flow, customers can activate their phones on the PayPal website or as part of the checkout
process when using Mobile Checkout.
If the customer has previously activated their phone, they log into PayPal Mobile Checkout
using their phone number and PIN. If the customer is not activated, they must enter their
PayPal user name (email) and password. They can then optionally create a new PIN.
Depending on the information PayPal gets about the phone number from cookies or the API
call, PayPal presents either the user name and password login option or the phone number and
PIN option.
Figure 1.1 illustrates the login flow for activated customers. Figure 1.2 illustrates the login
flow for non-activated customers.
8October 2009Mobile Checkout Developer Guide
FIGURE 1.1 Activated Mobile Checkout Flow
F
IGURE 1.2 Non-Activated Mobile Checkout Flow
PayPal Mobile Checkout Overview
Customer Activation for Mobile Checkout
1
Mobile Checkout Developer GuideOctober 20099
PayPal Mobile Checkout Overview
1
Mobile Checkout Processing Flow
Mobile Checkout Processing Flow
Table 1.1 shows the generic processing flow of a Mobile Checkout transaction. The Merchant
column entries in bold represent integration points, which are described in more detail in
subsequent sections.
TABLE 1.1 Mobile Checkout Processing Flow
CustomerMerchantPayPal
Selects product from
merchant mobile site,
website, client, or SMS
keyword list
Displays product details and gives customer
the option to pay with PayPal.
Selects PayPal by
clicking link to open
PayPal Mobile Checkout
Logs in to PayPal flow
and selects funding.
Confirms transaction on
merchant site, if
necessary
Calls SetMobileCheckout API to
initiate transaction
Receives API call and returns response
containing transaction token.
Redirects customer to PayPal URL with
token appended
Starts PayPal flow.
Redirects customer to merchantsupplied, secure Return URL.
Calls DoMobileCheckoutPayment API
to complete transaction
Displays order confirmation page
10October 2009Mobile Checkout Developer Guide
PayPal Mobile Checkout Overview
Mobile Checkout Processing Flow
Figure 1.3, “Mobile Checkout Processing Flow,” illustrates the processing flow for a Mobile
Checkout Transaction.
FIGURE 1.3 Mobile Checkout Processing Flow
1
Mobile Checkout Developer GuideOctober 200911
PayPal Mobile Checkout Overview
1
Merchant Integration Points
Merchant Integration Points
This section describes the merchant integration points shown in bold in Table 1.1.
Initiating the Transaction
When the customer clicks the Checkout with PayPal link or button, initiate the PayPal
transaction with a call to the SetMobileCheckout API. You can call SetMobileCheckout
using either PayPal SOAP Web Services or the PayPal Name-Value Pair (NVP) API. The
SetMobileCheckoutRequest contains the following information:
z Shopping cart information, including billing, tax, and shipping amounts and currencies
z PayPal flow information, including Return URL and Cancel URL
IMPORTANT: Always use a secure site for the return URL. Mobile browsers may not
smoothly handle the transition from secure sites (https) to unsecure sites
(http) and may display warning messages or experience delays.
z Customer information (optional), including name, phone number, shipping address, and e-
mail)
If you include the customer’s phone number, e-mail address, or shipping address in the
SetMobileCheckout request, these values are used as defaults within the PayPal flow. See
“SetMobileCheckout Request” on page 15 for more information about specific request fields.
The SetMobileCheckout response contains a Tok en , which identifies the transaction at
subsequent integration points. The token times out after 24 hours.
Redirecting to PayPal Mobile Checkout
After the response from SetMobileCheckout, you must redirect the customer’s browser to
PayPal. The SetMobileCheckout response contains a session token field, t. Add the value
of the token to the following URL and direct the customer’s browser to it in the following
form:
https://mobile.paypal.com/wc?t=<Token>
For example:
https://mobile.paypal.com/wc?t=Q234AD23AF92821
N OTE: Redirecting the customer to https://mobile.paypal.com/wc?t=<Token>
ensures best performance. However, you can also redirect to
https://www.paypal.com/wc?t=<Token>.
PayPal gets details about the customer (such as shipping address and payment method) and
then returns control back to the ReturnURL field from the SetMobileCheckout request.
This URL should be the final review page, if provided, where the customer confirms the order
and payment, or the confirmation page.
12October 2009Mobile Checkout Developer Guide
Completing the Transaction
After the customer has confirmed the transaction on your mobile site, complete the transaction
by calling the DoMobileCheckoutPayment API. The DoMobileCheckoutPayment
request contains the token from the SetMobileCheckout response.
N OTE: If you do not call DoMobileCheckoutPayment, the transaction is not completed.
The token returned by SetMobileCheckout times out after 24 hours. If you call
DoMobileCheckoutPayment with a expired token, an error is returned.
PayPal returns a DoMobileCheckoutPayment response, which contains the following
information:
z Customer information (including name, shipping address, and e-mail)
z Payment information (PayerInfo type, including billing, tax, and shipping amounts, and
other transaction information)
PayPal Mobile Checkout Overview
Merchant Integration Points
1
Mobile Checkout Developer GuideOctober 200913
PayPal Mobile Checkout Overview
1
Merchant Integration Points
14October 2009Mobile Checkout Developer Guide
Mobile Checkout API Reference
2
This chapter provides detailed specifications for the request and response fields for the
following Mobile Checkout APIs:
z SetMobileCheckout
z DoMobileCheckoutPayment
You can call these APIs using SOAP or Name-Value Pair (NVP). Field information for both
SOAP and NVP are provided.
SetMobileCheckout
Call this API to initiate a mobile checkout transaction.
The response returns a token that uniquely identifies the transaction. You must then redirect
the customer’s mobile browser to the following URL:
https://mobile.paypal.com/wc?t=<Token>
N OTE: Redirecting the customer to https://mobile.paypal.com/wc?t=<Token>
ensures best performance. However, you can also redirect to
https://www.paypal.com/wc?t=<Token>.
You must have approval from PayPal in order to use this API. Contact your PayPal Account
Manager for more information.
SetMobileCheckout Request
TABLE 2.1 SetMobileCheckout Request
SOAPNVPDescriptionData TypeReq?
BuyerPhone.
CountryCode
PHONE
COUNTRYCODE
Three-digit country code for buyer’s phone number.
Character length and limit: 3 single-byte characters
Currently, only 1 and 44 are supported..
ebl:Count
ryCodeTyp
e
No
Mobile Checkout Developer GuideOctober 200915
Mobile Checkout API Reference
2
SetMobileCheckout
T
ABLE 2.1 SetMobileCheckout Request
SOAPNVPDescriptionData TypeReq?
BuyerPhone.
PhoneNumber
ItemAmountAMTCost of item before tax and shipping.
ItemAmount.
CurrencyID
TaxTAXAMTTax on item purchased.
PHONENUMLocalized phone number used by the buyer to submit
the payment request (excludes country code). If the
phone number is activated for Mobile Checkout,
PayPal uses this value to pre-fill the PayPal login
page.
Character length and limit: 9 to 13 single-byte
characters
Character length and limitations: Must not exceed
$1,000 USD in any currency. No currency symbol.
Regardless of currency, decimal separator must be a
period (.), and the optional thousands separator must
be a comma (,).
N OTE: You must also set the
ItemAmount.CurrencyID field.
CURRENCY
CODE
A three-character currency code. Default: USD.
For allowable values, see
Supported Currencies
Character limit: 3 single-byte characters
N OTE: The tax amount must be in the same currency
as the ItemAmount.
Appendix A, “PayPal
.”
xs:stringNo
cc:Basic
AmountTyp
e
ns:Curren
cyCodeTyp
e
cc:Basic
AmountTyp
e
Ye s
Ye s
No
ShippingSHIPPINGAMTThe shipping costs for this transaction.
N OTE: The shipping amount must be in the same
currency as the ItemAmount.
Character length and limitations:
ItemNameDESCThe name of the item being ordered.
Character length and limitations: 127 single-byte
characters
ItemNumberNUMBERPass-through field allowing you to specify details,
such as SKU.
Character length and limitations: 127 single-byte
characters
16October 2009Mobile Checkout Developer Guide
cc:Basic
AmountTyp
e
xs:stringYe s
xs:stringNo
No
Mobile Checkout API Reference
SetMobileCheckout
T
ABLE 2.1 SetMobileCheckout Request
SOAPNVPDescriptionData TypeReq?
2
CustomCUSTOMThis element is a passthrough variable. Its value is
returned verbatim on the final PayPal Mobile
Checkout API, DoMobileCheckoutPayment. You
can use this value for whatever purpose you desire,
such as an accounting tracking number or additional
data needed by your applications (for example, a
session ID or other variable).
Character length and limitations: 256 single-byte
alphanumeric characters
InvoiceIDINVNUMYour own invoice number or ID used to identify the
transaction.
Character length and limitations: 127 single-byte
alphanumeric characters
ReturnURLRETURNURLThe customer’s browser returns to this URL after
choosing to pay with PayPal. The token is appended
to this URL as follows:
I MPORTANT: Always use a secure site for the return
URL. Mobile browsers may not
smoothly handle the transition from
secure sites (https) to unsecure sites
(http) and may display warning
messages or experience delays.
N OTE: PayPal recommends that the URL be the final
review page on which the customer confirms
the order and payment.
xs:stringNo
xs:stringNo
xs:stringYe s
Character length and limitations: no limit.
CancelURLCANCELURLThe customer is returned to this URL if they cancel
payment from within the PayPal flow by clicking the
Cancel or Return to Merchant buttons.
I MPORTANT: Always use a secure site for the
cancel URL. Mobile browsers may
not smoothly handle the transition
from secure sites (https) to unsecure
sites (http) and may display warning
messages or experience delays.
N OTE: PayPal recommends that the value be the
original page on which the customer chose to
pay with PayPal.
Character length and limitations: no limit
Mobile Checkout Developer GuideOctober 200917
xs:stringNo
Mobile Checkout API Reference
2
SetMobileCheckout
T
ABLE 2.1 SetMobileCheckout Request
SOAPNVPDescriptionData TypeReq?
Address
Display
ADDRESS
DISPLAY
Options
SharePhoneSHARE
PHONENUM
ShipTo
Address
Table 2.2
See
on page 19
Indicates whether a shipping address is required for
the transaction. Valid values are:
z 0 – A shipping address is not required. Default.
z 1 – A shipping address is required. If you pass a
value for ShippingAddress, that address is
displayed.
N OTE: Displaying the PayPal street address on file
does not allow the customer to edit that
address.
Indicates whether the customer’s phone number is
returned to the merchant. The customer will be
notified in the flow that the phone number is required
by the merchant, and can select not to provide the
number.
Allowable values:
z 0 – Phone number not returned. Default.
z 1 – Phone number returned.
The customer’s shipping address as stored by the
.
merchant. If this address is specified, it is displayed
during checkout. If not, the customer’s default
shipping address is displayed during checkout.
See
Table 2.2 on page 19. If you specify a Ship To
address, you must enter the fields marked as required
in
Table 2.2 on page 19.
xs:stringNo
xs:stringNo
ebl:Addre
No
ssType
N OTE: If a confirmed address is required by the
merchant’s profile, then only confirmed
addresses are displayed.
BuyerEmailEMAILEmail address of the buyer as entered during
checkout. If the phone number is not activated for
Mobile Checkout, PayPal uses this value to pre-fill the
ns:EmailA
ddressTyp
e
No
PayPal login page.
Character length and limit: 127 single-byte
alphanumeric characters
18October 2009Mobile Checkout Developer Guide
Mobile Checkout API Reference
SetMobileCheckout
TABLE 2.2 Ship To Address Fields
SOAPNVPDescriptionData TypeRequired
2
NameSHIPTO
NAME
Street1SHIPTO
STREET
Street2SHIPTO
STREET2
CityNameSHIPTO
CITY
StateOr
Province
CountrySHIPTO
SHIPTO
STATE
COUNTRY
Person’s name associated with this shipping
address.
Character length and limitations: 32 single-byte
characters
Street address line 1.
Character length and limitations: 300 single-byte
characters
Street address line 2.
Character length and limitations: 300 single-byte
characters
Name of city.
Character length and limitations: 120 single-byte
characters
State or province.
Character length and limitations: 120 single-byte
characters
ISO 3166 country code.
For allowable values, see
.”
Codes
Character limit: 2 single-byte characters
Appendix B, “Country
xs:stringNo
xs:stringYes
xs:stringNo
xs:stringYes
xs:stringNo
ns:Country
CodeType
Ye s
PostalCodeSHIPTO
ZIP
U.S. ZIP code or other country-specific postal
code.
Character length and limitations: 20 single-byte
characters
xs:stringNo
SetMobileCheckout Response
T
ABLE 2.3 SetMobileCheckout Response
SOAPNVPDescriptionData Type
TokenTOKENA timestamped token that uniquely identifies this transaction.
N OTE: The token expires after 24 hours.
Character length and limitations: 20 single-byte characters
Mobile Checkout Developer GuideOctober 200919
xs:string
Mobile Checkout API Reference
2
DoMobileCheckoutPayment
DoMobileCheckoutPayment
Call the DoMobileCheckoutPayment API to process the customer’s payment. If
DoMobileCheckoutPayment is successful, PayPal processes the payment.
DoMobileCheckoutPayment Request
TABLE 2.4 DoMobileCheckoutPayment Request
SOAPNVPDescriptionData TypeRequired
TokenTOKENA timestamped token that uniquely identifies this transaction.
Use the token returned in SetMobileCheckout response.
N OTE: The token returned by SetMobileCheckout
expires after 24 hours.
Character length and limitations: 20 single-byte characters
xs:stringYe s
DoMobileCheckoutPayment Response
T
ABLE 2.5 DoMobileCheckoutPayment Response
SOAPNVPDescriptionData Type
CustomCUSTOMThis element is a passthrough variable. Its value is
returned verbatim as set in the SetMobileCheckout
request. You can use this value for whatever purpose you
desire, such as an accounting tracking number or
additional data needed by your applications (for
example, a session ID or other variable).
Character length and limitations: 256 single-byte
alphanumeric characters
xs:string
InvoiceIDINVNUMYour own invoice or tracking number, as set by you in
the element of the same name in SetMobileCheckout
request .
Character length and limitations: 127 single-byte
alphanumeric characters
PayerInfoSee
Table 2.7
Information about the customer. See Table 2.7 on
page 24
.
xs:string
ebl:PayerInfo
Type
on page 24
20October 2009Mobile Checkout Developer Guide
Mobile Checkout API Reference
DoMobileCheckoutPayment
T
ABLE 2.5 DoMobileCheckoutPayment Response
SOAPNVPDescriptionData Type
2
PaymentInfoSee
Table 2.6
Information about the payment. See Table 2.6 on
page 21
.
ebl:PaymentInfo
Type
on page 21
ABLE 2.6 DoMobileCheckoutPayment Response: PaymentInfo Type
T
SOAPNVPDescriptionData Type
TransactionIDTRANSACTIONIDUnique transaction ID of the payment.
Character length and limitations: 19 single-byte
characters
Parent
TransactionID
PARENT
TRANSACTIONID
Parent or related transaction identification number. This
field is populated for the following transaction types:
z Reversal.
z Capture of an authorized transaction.
z Reauthorization of a transaction.
z Capture of an order. The value of
ParentTransactionID is the original OrderID.
z Authorization of an order. The value of
ParentTransactionID is the original OrderID.
z Capture of an order authorization.
z Void of an order. The value of ParentTransactionID
is the original OrderID.
Character length and limits: 16 digits in xxxx-xxxxxxxx-xxxx format (19 characters total)
xs:string
xs:string
ReceiptIDRECEIPTIDReceipt identification number.
xs:string
Character length and limits: 16 digits in xxxxxxxxxxxx-xxxx format
Transaction
Type
PaymentTypePAYMENTTYPEIndicates whether the payment is instant or delayed.
TRANSACTION
TYPE
The type of transaction. The transaction type for mobile
payments is send-money, as if the customer created
the transaction from the PayPal website.
Possible values are:
z none
z instant
ns:Payment
Transaction
CodeType
ns:Payment
CodeType
Character length and limitations: 7 single-byte
characters
PaymentDateORDERTIMEDate and time of payment.xs:dateTime
Mobile Checkout Developer GuideOctober 200921
Mobile Checkout API Reference
2
DoMobileCheckoutPayment
T
ABLE 2.6 DoMobileCheckoutPayment Response: PaymentInfo Type
SOAPNVPDescriptionData Type
GrossAmountAMTFull amount of the customer's payment, before
transaction fees are subtracted. This amount includes
any shipping and taxes from your Merchant Profile.
Character length and limitations: Does not exceed
$1,000 USD in any currency. No currency symbol.
Regardless of currency, decimal separator is a period (.),
and the optional thousands separator is a comma (,).
GrossAmount.
Currency
FeeAmountFEEAMTPayPal fee amount charged for the transaction.
FeeAmount.
Currency
SettleAmountSETTLEAMTAmount deposited in your PayPal account after a
CURRENCYCODECurrency code for the gross amount.
For possible values, see
Supported Currencies
N OTE: A single NVP field is returned for the currency
code for GrossAmount, FeeAmount,
SettleAmount, and TaxAmount.
Character length and limitations: No currency symbol.
Regardless of currency, decimal separator is a period (.),
and the optional thousands separator is a comma (,).
CURRENCYCODECurrency code for the gross amount.
For possible values, see
Supported Currencies
currency conversion.
Appendix A, “PayPal
.”
Appendix A, “PayPal
.”
cc:Basic
AmountType
ns:Currency
CodeType
cc:Basic
AmountType
ns:Currency
CodeType
cc:Basic
AmountType
SettleAmount.
Currency
TaxAmountTAXAMTTax charged on the transaction.
TaxAmount.Cur
rency
ExchangeRateEXCHANGERATEExchange rate if a currency conversion occurred.
22October 2009Mobile Checkout Developer Guide
CURRENCYCODECurrency code for the gross amount.
For possible values, see
Supported Currencies
Character length and limitations: No currency symbol.
Regardless of currency, decimal separator is a period (.),
and the optional thousands separator is a comma (,).
CURRENCYCODECurrency code for the gross amount.
For possible values, see
Supported Currencies
Relevant only if your are billing in the customer’s nonprimary currency. If the customer chooses to pay with a
currency other than the non-primary currency, the
conversion occurs in the customer’s account.
Character length and limitations: a numeric value that
does not exceed 17 characters, including decimal point
Appendix A, “PayPal
.”
Appendix A, “PayPal
.”
ns:Currency
CodeType
cc:Basic
AmountType
ns:Currency
CodeType
xs:string
Mobile Checkout API Reference
DoMobileCheckoutPayment
T
ABLE 2.6 DoMobileCheckoutPayment Response: PaymentInfo Type
SOAPNVPDescriptionData Type
2
PaymentStatusPAYMENTSTATUSStatus of a PayPal payment.
Status of the payment:
z Completed – The payment has been completed,
and the funds have been added successfully to your
account balance.
z Pending – The payment is pending. See the
PendingReason element for more information.
PendingReasonPENDINGREASONThe reason the payment is pending:
z none – No pending reason.
z address – The payment is pending because your
customer did not include a confirmed shipping
address and your Payment Receiving Preferences is
set such that you want to manually accept or deny
each of these payments. To change your preference,
go to the Preferences section of your Profile.
z intl – The payment is pending because you hold a
non-U.S. account and do not have a withdrawal
mechanism. You must manually accept or deny this
payment from your Account Overview.
z multi-currency – You do not have a balance in
the currency sent, and you do not have your
Payment Receiving Preferences set to
automatically convert and accept this payment. You
must manually accept or deny this payment.
z verify – The payment is pending because you are
not yet verified. You must verify your account
before you can accept this payment.
z unilateral – The payment is pending because it
was made to an email address that is not yet
registered or confirmed.
z upgrade – The payment is pending because it was
made via credit card and you must upgrade your
account to Business or Premier status in order to
receive the funds. upgrade can also mean that you
have reached the monthly limit for transactions on
your account.
z other – The payment is pending for a reason other
than those listed above. For more information,
contact PayPal customer service.
ns:Payment
StatusCode
Type
ReasonCodeREASONCODEThe reason for a reversal if PaymentStatus is
reversed. This field is always empty for Mobile
Checkout.
Mobile Checkout Developer GuideOctober 200923
ns:Reversal
ReasonCode
Type
Mobile Checkout API Reference
2
DoMobileCheckoutPayment
TABLE 2.7 DoMobileCheckoutPayment Response: PayerInfo Type
SOAPNVPDescriptionData Type
PayerEMAILPayer’s e-mail address.
Character length and limitations:
127 single-byte characters.
PayerIDPAYERIDUnique PayPal customer account
number.
Character length and limitations: 17
single-byte characters.
PayerStatusPAYERSTATUSStatus of the payer’s email address.ns:PayPalUserStatusCodeType
PayerNameSee
PayerCountryCOUNTRYCODEPayer’s country code.
Table 2.8
on page 24
Payer’s name. See Table 2.8 on
page 24
For possible values, see
.
ns:EmailAddressType
ns:UserIDType
ebl:PayerNameType
ns:CountryCodeType
Appendix B, “Country Codes.”
Character length and limitations:2
single-byte characters.
PayerBusinessBUSINESSPayer’s business name.
Character length and limitations:
127 single-byte characters.
AddressSee
Table 2.9
on page 25
Payer’s address. See Table 2.9 on
page 25
.
xs:string
ebl:AddressType
ContactPhonePHONENUMPhone number shared by the
customer with the merchant.
ABLE 2.8 DoMobileCheckoutPayment Response: PayerName Type
T
SOAPNVPDescriptionData Type
ebl__
Salutation
ebl__First
Name
ebl__Middle
Name
ebl__Last
Name
ebl__SuffixSUFFIXPayer’s suffixns:SuffixType
24October 2009Mobile Checkout Developer Guide
SALUTATIONPayer’s salutationns:Salutation
FIRSTNAMEPayer’s first namens:NameType
MIDDLENAMEPayer’s middle namens:NameType
LASTNAMEPayer’s last namens:NameType
xs:string
Type
Mobile Checkout API Reference
DoMobileCheckoutPayment
TABLE 2.9 DoMobileCheckoutPayment Response: Address Type
SOAPNVPDescriptionData Type
2
NameNAMEPerson’s name associated with shipping address.
Character length and limitations: 32 single-byte
characters
Street1SHIPTO
STREET
Street2SHIPTO
STREET2
CityNameSHIPTO
CITY
StateOr
Province
CountrySHIPTO
SHIPTO
STATE
COUNTRY
Street address line 1.
Character length and limitations: 300 single-byte
characters
Street address line 2.
Character length and limitations: 300 single-byte
characters
Name of city.
Character length and limitations: 120 single-byte
characters
Name of state or province.
Character length and limitations: 120 single-byte
characters
ISO 3166 country code.
For possible values, see
.”
Codes
Character length and limitations: Two single-byte
characters
Appendix B, “Country
xs:string
xs:string
xs:string
xs:string
xs:string
ns:Country
CodeType
PostalCodeSHIPTOZIPU.S. Zip code or other country-specific postal code.
Character length and limitations: 20 single-byte
characters
PhoneSHIPTOPHONE
NUM
Address
Owner
Address
Status
ADDRESS
OWNER
ADDRESS
STATUS
Phone number associated with this address.
eBay company that maintains this address: eBay or
PayPal
Status of the address on file with PayPal:
None
Confirmed
Unconfirmed
xs:string
ebl:AddressOw
nerTypeCode
ebl:AddressSt
atusCodeType
Mobile Checkout Developer GuideOctober 200925
Mobile Checkout API Reference
2
Error Codes
Error Codes
This section contains error codes that you may encounter in your application. Your application
may receive the following types of errors:
z Mobile Checkout Error Codes
z General API Errors
TABLE 2.10 Mobile Checkout Error Codes
Error CodeShort MessageLong MessageDescription
10001Internal ErrorInternal ErrorInternal API Error.
AddressDisplayOptions must
be 1 because your payment
receiving preferences require
the buyer to choose a
confirmed.
Recipient does not have a
confirmed address. For
SetMobileCheckout, either
specify
AddressDisplayOption =
1 or change payment receiving
preferences to not require a
confirmed address.
preferences do not allow this
transaction.
10823Internal ErrorInternal ErrorAttempted to share address or
phone to an unregistered phone
or email, which is not allowed.
26October 2009Mobile Checkout Developer Guide
Mobile Checkout API Reference
Error Codes
T
ABLE 2.10 Mobile Checkout Error Codes
Error CodeShort MessageLong MessageDescription
10824Internal ErrorInternal ErrorAll specified amounts must
have the same currency.
2
10825BuyerPhone is not supported
by PayPal Mobile.
10826Internal ErrorInternal ErrorCheckout session not completed
10827Internal ErrorInternal ErrorInvalid token.
10828Internal ErrorInternal ErrorToken has expired.
10829ShipToAddress is ignored
because your payment
receiving preferences require
the buyer to choose a
confirmed address.
10830ShipToAddress was an invalid
address.
10831BuyerPhone is an invalid
phone number.
10833Payment has already been
made for this InvoiceID.
10834Internal ErrorInternal ErrorSpecified token does not belong
BuyerPhone is not supported
by PayPal Mobile.
ShipToAddress is ignored
because your payment
receiving preferences require
the buyer to choose a
confirmed address.
ShipToAddress was an invalid
address.
BuyerPhone is an invalid
phone number.
Payment has already been
made for this InvoiceID.
Phone is valid but is not
supported by PayPal Mobile
(such as a country where the
service is not yet available.
by the buyer.
Ship To address ignored.
Invalid shipping address.
Invalid phone number.
Duplicate invoice number.
to the merchant making this
API call.
10835Internal ErrorInternal ErrorPayments to this merchant are
not available from the country
where the buyer account is
registered.
10836Internal ErrorInternal ErrorPayments to this merchant are
not available from the country
where a bank or credit card on
the buyer’s PayPal account is
registered.
Mobile Checkout Developer GuideOctober 200927
Mobile Checkout API Reference
2
Error Codes
TABLE 2.11 General API Errors
Short
Error Code
MessageLong MessageCorrecting This Error
10002Authentication
/Authorization
Failed
10002Authentication
/Authorization
Failed
10002Authentication
/Authorization
Failed
10002Internal ErrorInternal Error
10002Authentication
/Authorization
Failed
10002Authentication
/Authorization
Failed
Username/Password is incorrectThis error can be caused by
You do not have permissions to make this API
call
Account is locked or inactive
Internal Error
Account is not verified
an incorrect API username,
an incorrect API password,
or an invalid API signature.
Make sure that all three of
these values are correct. For
your security, PayPal does
not report exactly which of
these three values might be
in error.
10002Authentication
/Authorization
Failed
10002Authentication
/Authorization
Failed
10002Restricted
account
10002Authentication
/Authorization
Failed
10002Authentication
/Authorization
Failed
28October 2009Mobile Checkout Developer Guide
This call is not defined in the database!
Token is not valid
Account is restrictedYour PayPal merchant
account has been restricted.
Contact your PayPal account
manager for resolution.
Token is not valid
API access is disabled for this account
ABLE 2.11 General API Errors
T
Short
Error Code
MessageLong MessageCorrecting This Error
Mobile Checkout API Reference
Error Codes
2
10002Authentication
/Authorization
Failed
10002Restricted
account
Client certificate is disabled
Account is restricted
Mobile Checkout Developer GuideOctober 200929
Mobile Checkout API Reference
2
Error Codes
30October 2009Mobile Checkout Developer Guide
A
PayPal Supported Currencies
PayPal uses 3-character ISO-4217 codes for specifying currencies in fields and variables.
TABLE A.1 PayPal-Supported Currencies and Currency Codes
CurrencyCurrency Code
Australian Dollar AUD
Brazilian Real
N OTE: This currency is supported as a payment currency
and a currency balance for in-country PayPal
accounts only.
Canadian Dollar CAD
Czech Koruna CZK
Danish Krone DKK
Euro EUR
Hong Kong Dollar HKD
Hungarian Forint HUF
Israeli New Sheqel ILS
Japanese Yen JPY
Malaysian Ringgit
N OTE: This currency is supported as a payment currency
and a currency balance for in-country PayPal
accounts only.
Mexican Peso MXN
BRL
MYR
Norwegian Krone NOK
New Zealand Dollar NZD
Philippine Peso PHP
Polish Zloty PLN
Pound Sterling GBP
Singapore Dollar SGD
Swedish Krona SEK
Mobile Checkout Developer GuideOctober 200931
PayPal Supported Currencies
A
T
ABLE A.1 PayPal-Supported Currencies and Currency Codes
CurrencyCurrency Code
Swiss Franc CHF
Taiwan New Dollar TWD
Thai Baht THB
U.S. Dollar USD
32October 2009Mobile Checkout Developer Guide
B
CountryCode
AFGHANISTANAF
ÅLAND ISLANDSAX
ALBANIAAL
ALGERIADZ
AMERICAN SAMOAAS
ANDORRAAD
Country Codes
N OTE: This table lists country codes defined by ISO 3166-1.
Table 1: Country Codes
ANGOLAAO
ANGUILLAAI
ANTARCTICAAQ
ANTIGUA AND BARBUDA
ARGENTINAAR
ARMENIAAM
ARUBAAW
AUSTRALIAAU
AUSTRIAAT
AZERBAIJANAZ
BAHAMASBS
BAHRAINBH
BANGLADESHBD
AG
BARBADOSBB
Mobile Checkout Developer GuideOctober 200933
Country Codes
B
CountryCode
BELARUSBY
BELGIUMBE
BELIZEBZ
BENINBJ
BERMUDABM
BHUTANBT
BOLIVIABO
BOSNIA AND HERZE-
BA
GOVINA
BOTSWANABW
BOUVET ISLANDBV
BRAZILBR
BRITISH INDIAN
IO
OCEAN TERRITORY
BRUNEI DARUSSALAMBN
BULGARIABG
BURKINA FASOBF
BURUNDIBI
CAMBODIAKH
CAMEROONCM
CANADACA
CAPE VERDECV
CAYMAN ISLANDSKY
CENTRAL AFRICAN
CF
REPUBLIC
CHADTD
CHILECL
CHINACN
34October 2009Mobile Checkout Developer Guide
CountryCode
CHRISTMAS ISLANDCX
Country Codes
B
COCOS (KEELING)
CC
ISLANDS
COLOMBIACO
COMOROSKM
CONGOCG
CONGO, THE DEMO-
CD
CRATIC REPUBLIC OF
THE
COOK ISLANDSCK
COSTA RICACR
COTE D'IVOIRECI
CROATIAHR
CUBACU
CYPRUSCY
CZECH REPUBLICCZ
DENMARKDK
DJIBOUTIDJ
DOMINICADM
DOMINICAN REPUBLICDO
ECUADOREC
EGYPTEG
EL SALVADORSV
EQUATORIAL GUINEAGQ
ERITREAER
ESTONIAEE
ETHIOPIAET
Mobile Checkout Developer GuideOctober 200935
Country Codes
B
CountryCode
FALKLAND ISLANDS
FK
(MALVINAS)
FAROE ISLANDSFO
FIJIFJ
FINLANDFI
FRANCEFR
FRENCH GUIANAGF
FRENCH POLYNESIAPF
FRENCH SOUTHERN
TF
TERRITORIES
GABONGA
GAMBIAGM
GEORGIAGE
GERMANYDE
GHANAGH
GIBRALTARGI
GREECEGR
GREENLANDGL
GRENADAGD
GUADELOUPEGP
GUAMGU
GUATEMALAGT
GUERNSEYGG
GUINEAGN
GUINEA-BISSAUGW
GUYANAGY
HAITIHT
36October 2009Mobile Checkout Developer Guide
CountryCode
Country Codes
B
HEARD ISLAND AND
HM
MCDONALD ISLANDS
HOLY SEE (VATICAN
VA
CITY STATE)
HONDURASHN
HONG KONGHK
HUNGARYHU
ICELANDIS
INDIAIN
INDONESIAID
IRAN, ISLAMIC REPUB-
IR
LIC OF
IRAQIQ
IRELANDIE
ISLE OF MANIM
ISRAELIL
ITALYIT
JAMAICAJM
JAPANJP
JERSEYJE
JORDANJO
KAZAKHSTANKZ
KENYAKE
KIRIBATIKI
KOREA, DEMOCRATIC
KP
PEOPLE'S REPUBLIC OF
KOREA, REPUBLIC OFKR
KUWAITKW
Mobile Checkout Developer GuideOctober 200937
Country Codes
B
CountryCode
KYRGYZSTANKG
LAO PEOPLE'S DEMO-
LA
CRATIC REPUBLIC
LATVIALV
LEBANONLB
LESOTHOLS
LIBERIALR
LIBYAN ARAB JAMA-
LY
HIRIYA
LIECHTENSTEINLI
LITHUANIALT
LUXEMBOURGLU
MACAOMO
MACEDONIA, THE
MK
FORMER YUGOSLAV
REPUBLIC OF
MADAGASCARMG
MALAWIMW
MALAYSIAMY
MALDIVESMV
MALIML
MALTAMT
MARSHALL ISLANDSMH
MARTINIQUEMQ
MAURITANIAMR
MAURITIUSMU
MAYOTTEYT
MEXICOMX
38October 2009Mobile Checkout Developer Guide
CountryCode
Country Codes
B
MICRONESIA, FEDER-
FM
ATE D S TAT E S OF
MOLDOVA, REPUBLIC OFMD
MONACOMC
MONGOLIAMN
MONTSERRATMS
MOROCCOMA
MOZAMBIQUEMZ
MYANMARMM
NAMIBIANA
NAURUNR
NEPALNP
NETHERLANDSNL
NETHERLANDS ANTI-
AN
LLES
NEW CALEDONIANC
NEW ZEALANDNZ
NICARAGUANI
NIGERNE
NIGERIANG
NIUENU
NORFOLK ISLANDNF
NORTHERN MARIANA
MP
ISLANDS
NORWAYNO
OMANOM
PAKISTANPK
Mobile Checkout Developer GuideOctober 200939
Country Codes
B
CountryCode
PAL AUPW
PALESTINIAN TERRI-
PS
TORY, OCCUPIED
PAN AM APA
PAPUA NEW GUINEAPG
PARAGUAYPY
PERUPE
PHILIPPINESPH
PITCAIRNPN
POLANDPL
PORTUGALPT
PUERTO RICOPR
QATARQA
REUNIONRE
ROMANIARO
RUSSIAN FEDERATIONRU
RWANDARW
SAINT HELENASH
SAINT KITTS AND
KN
NEVIS
SAINT LUCIALC
SAINT PIERRE AND
PM
MIQUELON
SAINT VINCENT AND
VC
THE GRENADINES
SAMOAWS
SAN MARINOSM
40October 2009Mobile Checkout Developer Guide
CountryCode
Country Codes
B
SAO TOME AND PRINC-
ST
IPE
SAUDI ARABIASA
SENEGALSN
SERBIA AND MON-
CS
TENEGRO
SEYCHELLESSC
SIERRA LEONESL
SINGAPORESG
SLOVAKIASK
SLOVENIASI
SOLOMON ISLANDSSB
SOMALIASO
SOUTH AFRICAZA
SOUTH GEORGIA AND
GS
THE SOUTH SANDWICH
ISLANDS
SPAINES
SRI LANKALK
SUDANSD
SURINAMESR
SVALBARD AND JAN
SJ
MAYEN
SWAZILANDSZ
SWEDENSE
SWITZERLANDCH
SYRIAN ARAB REPUB-
SY
LIC
Mobile Checkout Developer GuideOctober 200941
Country Codes
B
CountryCode
TAIWAN, PROVINCE OF
TW
CHINA
TAJIKISTANTJ
TANZANIA, UNITED
TZ
REPUBLIC OF
THAILANDTH
TIMOR-LESTETL
TOGOTG
TOKELAUTK
TONGATO
TRINIDAD AND
TT
TOBAGO
TUNISIATN
TURKEYTR
TURKMENISTANTM
TURKS AND CAICOS
TC
ISLANDS
TUVALUTV
UGANDAUG
UKRAINEUA
UNITED ARAB EMIR-
AE
AT E S
UNITED KINGDOMGB
UNITED STATESUS
UNITED STATES MINOR
UM
OUTLYING ISLANDS
URUGUAYUY
UZBEKISTANUZ
VANUATUVU
42October 2009Mobile Checkout Developer Guide
CountryCode
VENEZUELAVE
VIET NAMVN
Country Codes
B
VIRGIN ISLANDS, BRIT-
VG
ISH
VIRGIN ISLANDS, U.S.VI
WALLIS AND FUTUNAWF
WESTERN SAHARAEH
YEMENYE
ZAMBIAZM
ZIMBABWEZW
Mobile Checkout Developer GuideOctober 200943
Country Codes
B
44October 2009Mobile Checkout Developer Guide
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.