paypal/paypal-ios-sdk

Accept credit cards and PayPal in your iOS app

Important: PayPal Mobile SDKs are Deprecated. The APIs powering them will remain operational long enough for merchants to migrate, but the SDKs themselves will no longer be updated. Please use Braintree Direct in supported countries. In other countries, use Express Checkout and choose the Braintree SDK integration option.

PayPal iOS SDK

The PayPal iOS SDK makes it easy to add PayPal payments to mobile apps.

This documentation is available in Japanese: 日本語のドキュメント.

Note

There are 4 static libraries that you should link when building your application. libPayPalMobile.a, libCardIO.a, libopencv_core.a', and libopencv_imgproc.a` are required for all of the SDK functionality.

The current version of the PayPal iOS SDK was built using Xcode 8.3.2.

Contents

• Use Cases
• Requirements
• Add the SDK to Your Project
• Credentials
• International Support
• Testing
• Documentation
• Usability
• Next Steps

Use Cases

The SDK supports two use cases for making payments - Single Payment and Future Payments - and a third use case for obtaining information about the customer - Profile Sharing.

Single Payment

Receive a one-time payment from a customer's PayPal account. This can be either (1) an immediate payment which your servers should subsequently verify, or (2) an authorization for a payment which your servers must subsequently capture, or (3) a payment for an order which your servers must subsequently authorize and capture:

1. Accept a Single Payment and receive back a proof of payment.
2. On your server, Verify the Payment, Capture the Payment, or Process the Order (PayPal Developer site) using PayPal's API.

Note: Direct Credit Card (DCC) payments are now deprecated in this SDK. Please use Braintree Payments, a PayPal Company, which is the easiest way to accept PayPal, credit cards, and many other payment methods.

Future Payments

Your customer logs in to PayPal just one time and consents to future payments:

1. Obtain Customer Consent to receive an authorization code.
2. On your server, use this authorization code to Obtain OAuth2 Tokens.

Later, when that customer initiates a payment:

1. Obtain a Client Metadata ID that you'll pass to your server.
2. On your server, Create a Payment using your OAuth2 tokens, the Client Metadata ID, and PayPal's API.

Profile Sharing

Your customer logs in to PayPal and consents to PayPal sharing information with you:

1. Obtain Customer Consent to receive an authorization code.
2. On your server, use this authorization code to Obtain OAuth2 Tokens.
3. On your server, Retrieve Customer Information using your OAuth2 tokens and PayPal's API.

Requirements

• Xcode 8 and iOS SDK 10
• iOS 7.0+ target deployment
• armv7, armv7s, and arm64 devices, and the simulator (not armv6)
• iPhone and iPad of all sizes and resolutions

Add the SDK to Your Project

If you use CocoaPods, then add these lines to your podfile:

platform :ios, '7.0'
pod 'PayPal-iOS-SDK'

If you don't use CocoaPods, then:

1. Clone or download the SDK, which consists of header files, license acknowledgements, release notes, and a static library. It also includes a sample app.
   • As of version 2.17.0, the SDK requires Xcode 8 and iOS 10 SDK.
2. Add the PayPalMobile directory (containing several .h files and libPayPalMobile.a) to your Xcode project. We recommend checking "Copy items..." and selecting "Create groups...".
3. In your project's Build Settings (in the TARGETS section, not the PROJECTS section):

• add -lc++ -ObjC to Other Linker Flags
• enable Enable Modules (C and Objective-C)
• enable Link Frameworks Automatically

4. In your project's Build Phases, link your project with these libraries. Weak linking for iOS versions back to 6.0 is supported.

• Accelerate.framework
• AudioToolbox.framework
• AVFoundation.framework
• CoreLocation.framework
• CoreMedia.framework
• MessageUI.framework
• MobileCoreServices.framework
• SystemConfiguration.framework
• SafariServices.framework

With or without CocoaPods:

1. Add the open source license acknowledgments from acknowledgments.md to your app's acknowledgments.
2. In your app's Info.plist, add the following URL schemes to LSApplicationQueriesSchemes:

• com.paypal.ppclient.touch.v1
• com.paypal.ppclient.touch.v2
• org-appextension-feature-password-management

Credentials

Your mobile integration requires different client_id values for each environment: Live and Test (Sandbox).

Your server integrations for verifying or creating payments will also require the corresponding client_secret for each client_id.

You can obtain these PayPal API credentials by visiting the Applications page on the PayPal Developer site and logging in with your PayPal account.

Sandbox

Once logged in on this Applications page, you will be assigned test credentials, including Client ID, which will let you test your iOS integration against the PayPal Sandbox.

While testing your app, when logging in to PayPal in the SDK's UI you should use a personal Sandbox account email and password. I.e., not your Sandbox business credentials.

You can create both business and personal Sandbox accounts on the Sandbox accounts page.

Live

To obtain your live credentials, you will need to have a business account. If you don't yet have a business account, there is a link at the bottom of that same Applications page that will get you started.

International Support

Localizations

The SDK has built-in translations for many languages and locales. See the header files for a complete list.

Currencies

The SDK supports multiple currencies. See the REST API country and currency documentation for a complete, up-to-date list.

If your app initiates a transaction with a currency that turns out to be unsupported for the user's selected payment type, then the SDK will display an error to the user and write a message to the console log.

Testing

During development and testing, set the environment to Sandbox or NoNetwork/Mock mode, to avoid moving real money around. See the header files for more information.

Documentation

• These docs in the SDK, which include an overview of usage, step-by-step integration instructions, and sample code.
• The sample app included in this SDK.
• Header files are thoroughly documented; refer to them as needed for extra details about any given property or parameter.
• The PayPal Developer Docs, which cover error codes and server-side integration instructions.

Support

When opening an issue, please include the environment (live or sandbox), SDK version, and a PayPal-Debug-ID. The console log may have something like:

PayPal SDK: Request has failed with error: INTERNAL_SERVICE_ERROR - System error. Please try again later. (500) | PayPal Debug-ID: 463acd5lba23c [live, PayPal iOS SDK 2.14.1]

Additionally, information about the types of devices (iPhone 6s Plus, iPhone 5), iOS version, and any non-standard settings would be helpful to provide.

For merchant-specific issues, you should use the PayPal Merchant Technical Support site to open an issue.

Please do not post your client ID or secret in an issue.

Usability

User interface appearance and behavior is set within the library itself. For the sake of usability and user experience consistency, apps should not adjust appearance properties or attempt to modify the SDK's behavior beyond the documented methods in the provided headers.

Specifically, if you are using UIAppearance to modify the appearance of any UI elements in your app, you should reverse those changes prior to presenting our viewcontroller, and set them again after dismissing the viewcontroller.

Next Steps

Depending on your use case, you can now:

• Accept a single payment
• Obtain user consent to create future payments.
• Obtain user consent to retrieve customer information.

Contributing

Please read our contributing guidelines prior to submitting a Pull Request.

License

Please refer to this repo's license file.

paypal-ios-sdk's Issues

App rejected under iOS 7. Use of non-public selectors.

I am using the latest iOS SDK (1.3.3). When validating the app before submission, I am presented with the warning: "The app references non-public selectors in Payload/App.app/Appname: id, setId".

I searched my project using terminal and the command,
$ find . | grep -v .svn | grep ".a" | grep -v ".app" | xargs grep setId

This returns a single result in my project being the libPayPalMobile.a file.
What do I do here as I need to update my app ASAP?

Support currency codes other than USD

As is mentioned in the PayPalPayment header, "[NOTE: at this time, only USD is supported]".

Is there any support for other currency codes on the way?

Using Version 1.3.5 but still saying only USD is only allowed ?

Hi,

We are using IOS PAYPAL SDK v1.3.5 for CANDIAN DOLLAR, but it is giving us error message back as "PayPalPayment not processable: At this time, 'USD' is the only currency code allowed." However as per release v 1.2.0 at https://github.com/paypal/PayPal-iOS-SDK/releases/tag/1.2.0 it should allow CAD as well.

Don't know what is the problem, can you please have a look?

Thanks

Need support for shipping_address

We've been using Mobile Express Payments for our app and we'd like to move to the new iOS SDK but it doesn't yet support a few payment properties that our accountants need: subtotal, tax and shipping.

I see in the REST API that these properties are available under the payment details element, so it seems like the server support is available. Maybe they could be added as PayPalPayment object properties in addition to currencyCode, amount and shortDescription?

Do you have plans to add these properties any time soon? Thanks.

"ppapi_error_code_10870 - Please go to the App Store to install the latest version of the PayPal app.

I've been able to successfully run through sandbox mode up until today. I'm able to set the app into production mode and it works fine. Here is the debugId.

PayPal debugId: d0eabe41e190b"

Please create a new information doc

Hello

I have read the document included with example. The doc is very old as X.com is not supported to submit the app.

I need to submit the app to paypal but none of the doc is proper as per website. currently I can not seen My Account > Profile > My Selling Tools.

So please upload new doc with proper app submission guide.

Thanks

Library is rejected by Apple

The library contains a call to uniqueIdentifier on UIDevice or at least a method that has the same name. Linking against this library will get the app rejected by apple as of May 1st.
A new version of the library without a call to uniqueIdentifier or having a method with the name uniqueIdentifier is needed!

iOS 7 UI

I'm working to implement the PayPal SDK into an iOS 7 app and am finding some consistency issues. It looks like the "tintColor" property is being set on the navigationBar and/or the UIBarButtonItems found in the toolbar. Can you conditionally compile these to use barTintColor instead in this case?

Landscape only app issues

There are some bugs when the paypal viewcontroller is used in a Landscape only app.

When it is first activated, it is fine. It is appears to adjust to landscape.

If you click on "Credit Card" -> the keyboard obscures some of the textfields. It is hard to scroll down.

if you click on "paypal" -> obscuring issues re: keyboard + hard to scroll down

They above issues are MINOR.

Now, on your first try (initial state), if you click on credit card -> the landscape credit card screen comes up.

If you now click cancel, the paypal view controller turns into portrait mode.
Now if you go back into EITHER paypal mode or credit card mode, the keyboard is totally STUFFED UP (it remains in portrait mode).

The keyboard is not correctly drawn on the screen. It shows the graphics for the keyboard but it is not even lined up at bottom of screen. It is in mid-air. It also does not respond at all or or properly.

Buyer's Shipping Address Not Included

We've just implemented this library in our app to enable purchasing of physical goods. However, once we ran a live test, we realized that the transaction receipt does not include the buyer's shipping address (even though the buyer has one verified on her account). Why is that? I've read that this may happen when payment is sent as a gift. Is this the default type of payment in this library? I don't see a way to specify it for "Goods". Could someone shed light on this? Thanks

CocoaPods Version is out of date.

The most recently available version is 1.0.4, so it seems like it hasn't been updated in awhile.

Support for subscriptions / recurring payments

Support for subscriptions / recurring payments would be a welcome future addition!

Pay with Credit Card navigation bar tint color

Hi,

It seems the barTintColor on the navigation bar in the pay with credit card screen is hardcoded to white. We need the text(tint color) to be white, so we need to be able to change the background color of the nav bar. Could you please adjust this so the nav bar honors the appearance setting for the nav bar barTintColor. We would like to release an app with a week that depends on this. Any quick help would be much appreciated.

Bruce McTigue

No support for Adaptive parallel, chained payments

The older MPL for iOS seemed to have support for chained and parallel payments using adaptive payments.

This library does not seem to have support for it.

Pls. clarify.

Any plans to provide it ?

Update library using blocks

Hey,

I created a sample subclass using Objective-C blocks. Using delegates is quite old fashioned:

https://github.com/nerdishbynature/PBPayPalPaymentViewController

Cheers,

Piet.

Support for only the REST api?

I already have developed the views for the credit card. I support other payments processors. I wish to use the paypal sdk only for the processing, not for the visuals.

Paypal Android SDK integration

Hi,
I am trying to develop an application for a Kiosk for a non-profit organization where donors can come and donate using their credit cards and once payment has been successful, my application can update the back end system (running on a hosted server) for the donor info etc for book keeping.
I have 2 choices
1- Use paypal newly released android SDK which can scan the card using card.io SDK and process the payment
2- Use paypal here card reader, and using the sideloader API , start the HERE application and take payment .

My question is, since it is a kiosk , users will not have paypal credentials and in paypal here application we need to enter username/passwd all the time . Is it true for the Android SDK solution too ?
Also, does the card.io based SDK works with front facing cameras (Nexus 7) ?

Please provide expert advice .

License for library?

In the Cocoapods Specs library there was some debate about the license of the PayPal SDK, CocoaPods/Specs#1442 - is it fine to just consider it a Commercial license and leave it at that?

Support reapprove workflow for PayPal

I see that this SDK does not support reapprove payment flow now.

PayPalPaymentViewController only support Portrait?

As the title, I am developing an iPad app, Is there any method make the view to rotate in landscape mode?

Support for PayPal Here card reader in iOS SDK

Does anyone know if this has been added yet? I have a client application that uses the iOS SDK, but my client would also like to use the PayPal Here card reader. Is there anyway to integrate this in with the current SDK?

Multiple receiverEmail

I am going to use dynamic receipt email in Paypal id.
Is it possible to use multiple email address in Paypal SDK?

Support for countries outside the US

ETA ?

PayPalPayment shortDescription obscuring total charge amount

Charge amount is not displayed when the PayPalPayment shortDescription is too long.

This effects both "Your Order" and "Confirm" views.

Nil payerId causes crash on iOS 6 with PayPal-iOS-SDK-1.3.0-beta

PayPal-iOS-SDK-1.3.0-beta
In the PayPalPaymentViewController, tap "Pay with Card" button
Tap Enter Manually button
Card Number: 5555 5555 5555 4444
Expiration: 12/13
CVV: 123
Tap Done
Crash!

[4038:907] *** Assertion failure in -[UITableView _endCellAnimationsWithContext:], /SourceCache/UIKit/UIKit-2380.17/UITableView.m:909
[4038:907] *** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'attempt to insert row 2 into section 0, but there are only 2 rows in section 0 after the update'
*** First throw call stack:
(0x341382a3 0x3bfdc97f 0x3413815d 0x34a0dab7 0x35f73a9f 0x41a2ed 0x442343 0x4425c9 0x44249d 0x419d5f 0x418313 0x35fa7311 0x35fc4079 0x35fa7311 0x35fe1d15 0x36056d19 0x35fdb6bf 0x35fdb499 0x35f55ab3 0x35fca8ef 0x35cffc01 0x3c3f34b7 0x3c3f81bd 0x3410bf3b 0x3407eebd 0x3407ed49 0x37c332eb 0x35f94301 0xd10c1 0xd1048)
libc++abi.dylib: terminate called throwing an exception

PAYER_ID_MISSING_FOR_CARD_TOKEN

I have a unique customer number associated with the payer id but I am receiving this error when trying to make a purchase using a saved card. The initial purchase with the card works, only on subsequent purchases when the card is saved do I receive this error. Any help would be great.

thanks

Credit card photography - Card image obscures manual entry fields on iPad

credit card photo is on the field of expiration date

Support for pre approved payments

Would be nice to have this feature. I see it was originally included in the iOS Mobile Payments Library.

Are there any plans to introduce this?

smaller library without the CardIO /card scanning support

In our application, we do not need the payment with card option, thus we do not want the Card interface CardIO . But we still need to add in extra frameworks for CoreVideo, CoreMedia, OpenGLES, AVFoundation in order to compile. Our app binary file becomes much bigger and we really don't want to add extra frameworks.
Is there any way to have a smaller, compact library with just the core PayPal Payment, not bundled with the CardIO interface? The reason we have to try this SDK because the MPL SDK contains UIDevice uniqueIdentifier that fails Apple AppStore. thanks.

Back text overlaps Cancel text

I'm not sure if anyone has found this already, but I just installed the latest plugin and while running on an iOS 7 simulator I get this strange overlap. Once I hit cancel and open it again its fine. Just a minor detail.

Cheers

"Unauthorized Payment" error with valid credit card in Live environment

We are done with testing iOS SDK in sandbox and are now testing payment in live environment for our iOS app. We are using SDK version 1.1.1 and used the live client ID retrieved from the app development site associated with our PayPal business account. Payment goes through without a problem when paid from a PayPal account but the credit card payment using "Pay with Card" feature doesn't seem to work. With a valid credit card information entered, we are having an error "Unauthorized Payment" and I have no clue on why we receive this error only with the credit card payment. Please refer to the following error message below. Any help will be appreciated.

Issue with payment confirmation view in iOS 7

Greetings,

First off, I love this library! Made my life much easier!

My issue is that after migrating my app to iOS 7 (iPhone), the final view that offers to send a receipt for your payment is not properly laid out. The text is scrolled up too high so you cannot read the payment confirmation info. Is this going to be fixed soon, or is it already somehow? Or is there a way I can change this myself?

Thanks! I just have a feeling my app will get rejected if this cannot be read, and it isn't a good customer experience either. Thanks in advance!!

Jason

Label with obvious white background in PayPalPaymentViewController in iOS 6 for SDK 1.3.3

It's quite ugly, could we make the label background to clearColor instead? I know it looks fine on iOS 7 apps because the table view cell is white. But for iOS 6 it isn't and is actually a little unprofessional.. Thanks!

Support for LLVM libc++ library

The libPayPalMobile.a file seems to only work with libstdc++, not with the newer libc++ library that Apple uses as the default for new Xcode projects. It would be nice if you included an alternative version of libPayPalMobile.a that was compiled against the newer library.

User paying with credit card

I've noticed that if a user pays using credit card (without logging into paypal), after the payment is completed, the USER is expected to type out his own receipt.

This is quite ugly. How can I disable this? I'd rather send them a receipt via the verification process after asking for their email address.

Undefined symbols for i386 when linking

I get this:

Undefined symbols for architecture i386:
"std::terminate()", referenced from:
___clang_call_terminate in PayPalMobile.a(CardIOGPURenderer.o)
"___cxa_begin_catch", referenced from:
___clang_call_terminate in PayPalMobile.a(CardIOGPURenderer.o)
"___gxx_personality_v0", referenced from:
Dwarf Exception Unwind Info (__eh_frame) in PayPalMobile.a(CardIOAnalytics.o)
Dwarf Exception Unwind Info (__eh_frame) in PayPalMobile.a(CardIOGPURenderer.o)
Dwarf Exception Unwind Info (__eh_frame) in PayPalMobile.a(CardIOAnalytics.o)
Dwarf Exception Unwind Info (__eh_frame) in PayPalMobile.a(CardIOGPURenderer.o)
ld: symbol(s) not found for architecture i386
clang: error: linker command failed with exit code 1 (use -v to see invocation)

when trying to link in PayPal. I made the PayPalMobile.a file required and I added the other linker flags of -lc++ and Objc. I also checked all of the required frameworks mentioned in the README. Any thoughts?

Larry

SDK 1.3.3 Linker errors on iOS 7 device

Hi gays! After installing the new SDK 1.3.3 I get the 6 linker errors (on device iphone5 ios7, on simulator it work nice) like following :

Undefined symbols for architecture armv7s:
"std::__1::__vector_base_common::__throw_length_error() const", referenced from:
std::__1::vector >::__append(unsigned long) in libPayPalMobile.a(dmz_all.o)
std::__1::vector, std::__1::allocator > >::__append(unsigned long) in libPayPalMobile.a(matrix.o)
...
...
"std::__1::basic_string, std::__1::allocator >::operator=(std::__1::basic_string, std::__1::allocator > const&)", referenced from:
cv::Exception::formatMessage() in libPayPalMobile.a(system.o)
...
...
...

Verification Process

After sending completedpayment details to my server for verification, what am I meant to do with it. It's not technically essential - the money still comes in. IS IT MERELY a paypal requirement?

I can write a server-side script in php to compare the completedpayment details with paypal's transaction details via the paypal API.

What am i meant to do if after doing the comparison, there is a discrepancy? Just being devils-advocate, Why should I care also - since the money will come into my account regardless.

If there is no discrepancy, should I store the details into my own server-side database?

I am really confused on what I am meant to do with the verification process. Paypal documentation keeps saying it is to reduce fraud - but if the money has already come in, someone is entitled to the product/service that they bought from me.

extra fees for card.io credit card scanning?

when using the card.io credit card scanning in the paypal iOS sdk, are there extra charges per transaction (above paypal's normal fees)? i know card.io charges $0.15 per scan when you use their sdk.

Support for PayPal Here card reader

It would be nice to have support for the PayPal Here card reader in addition to the card.io camera input.

Open Source?

Why not letting this project open source so we can improve it by ourselves?

How to set invoice in payment detail,API not support

The IPN paypal post data not contain invoice,how and where to set that in API. Can you help me!

There is a problem communicating with the PayPal servers . Please try again.

We tested the code in Sandbox environment , it was OK.

When we switch to Live/Production environment , modifying the credentials under ZZMainViewController.h in the sample code within the PayPal-iOS-SDK.zip
live credentials obtained from https://developer.paypal.com/webapps/developer/applications/myapps

define kPayPalClientId @"..."

define kPayPalReceiverEmail @"..."

self.acceptCreditCards = NO;
self.environment = PayPalEnvironmentProduction;

We keep getting this error, in both iphone simulator and live iphone devices:

There is a problem communicating with the PayPal servers . Please try again.

We can log in to PayPal live, but when click send payment, the problem occurs. Attached are the screenshots.

Need Paypal support for PhoneGap Apps

Availability in other country and currency.

Hello there i am having a confusion. I wanted to know if teh current SDK will work for US paypal accounts only? OR it will work for any account worldwide provided that the currency will only be USD for the time being?

Express Payment via Creditcard

Hi,

is there a way to start the card reader/scanner directly from within the PayPalPaymentViewController? We do not want the extra screen displaying paypal and credit card button. Our intention is to place those two buttons in our own view controller next to three more payment options. From this view controller both buttons will start the PayPalPaymentViewController straight forward to the choice we did before BUT we would like to avoid the upcoming choice of paypal or credit card and want to force one or the other directly without another tab of the user.

Thanks a lot for your help!

Need to add Credit card information prior to actual payment while Registering user

Hi In my app I Need to add Credit card information prior to actual payment while Registering user. Is it possible to create a view which only store credit card for later usage.

ld: symbol(s) not found for architecture i386

Every time I run this I get this error:

Undefined symbols for architecture i386:

  "_OBJC_CLASS_$_PayPalPayment", referenced from:

      objc-class-ref in ViewController.o

  "_OBJC_CLASS_$_PayPalPaymentViewController", referenced from:

      objc-class-ref in ViewController.o

  "_PayPalEnvironmentNoNetwork", referenced from:

      -[ViewController Pay:] in ViewController.o

ld: symbol(s) not found for architecture i386

clang: error: linker command failed with exit code 1 (use -v to see invocation)

Undefined symbols for architecture i386

Per a recent email from a developer:

everytime i run this i get this error 
Undefined symbols for architecture i386:
  "_OBJC_CLASS_$_PayPalPayment", referenced from:
      objc-class-ref in ViewController.o
  "_OBJC_CLASS_$_PayPalPaymentViewController", referenced from:
      objc-class-ref in ViewController.o
  "_PayPalEnvironmentNoNetwork", referenced from:
      -[ViewController Pay:] in ViewController.o
ld: symbol(s) not found for architecture i386
clang: error: linker command failed with exit code 1 (use -v to see invocation)

Support for arm64 binary and iPhone 5s

The current version of libPayPalMobile.a has support for armv7, armv7s, and i386 binaries. However, it doesn't have support for arm64 so building for the iPhone 5s device issues linker errors.

Here's the linker message:

ld: warning: ignoring file .../libPayPalMobile.a, missing required architecture arm64 in file .../libPayPalMobile.a (3 slices)
Undefined symbols for architecture arm64:
"OBJC_CLASS$_PayPalPayment", referenced from:
objc-class-ref in MoxiePayPalViewer.o
"OBJC_CLASS$_PayPalPaymentViewController", referenced from:
objc-class-ref in MoxiePayPalViewer.o
"_PayPalEnvironmentNoNetwork", referenced from:
-[MoxiePayPalViewer showContentWithURL:paramList:] in MoxiePayPalViewer.o
ld: symbol(s) not found for architecture arm64
clang: error: linker command failed with exit code 1 (use -v to see invocation)