Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hansemannn/titanium-paypal

💰 Use the PayPal iOS-SDK 2.x with Titanium Mobile.
https://github.com/hansemannn/titanium-paypal

appcelerator ios native paypal titanium-mobile

Last synced: about 1 month ago
JSON representation

💰 Use the PayPal iOS-SDK 2.x with Titanium Mobile.

Host: GitHub
URL: https://github.com/hansemannn/titanium-paypal
Owner: hansemannn
License: other
Created: 2016-05-29T20:17:55.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2018-07-17T12:57:38.000Z (over 6 years ago)
Last Synced: 2024-11-16T00:33:32.250Z (about 2 months ago)
Topics: appcelerator, ios, native, paypal, titanium-mobile
Language: Objective-C
Homepage:
Size: 53.2 MB
Stars: 22
Watchers: 7
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # PayPal iOS SDK in Appcelerator Titanium

[![Build Status](https://travis-ci.org/hansemannn/titanium-paypal.svg?branch=master)](https://travis-ci.org/hansemannn/titanium-paypal) [![License](http://hans-knoechel.de/shields/shield-license.svg)](./LICENSE) [![Contact](http://hans-knoechel.de/shields/shield-twitter.svg)](http://twitter.com/hansemannnn)



## Summary

Ti.PayPal is an open-source project to support the PayPal iOS-SDK 2.x in Appcelerator's Titanium Mobile. The module currently supports the following API's:

- [x] Simple Payments

- [x] Future Payments

- [x] Merchant Configuration

> Note: This is the iOS version of Ti.PayPal. You might want to check [appwert/ti.paypal](https://github.com/AppWerft/Ti.Paypal) for the Android equivalent 🚀.

## Requirements

- [x] Titanium Mobile SDK 5.2.0+

- [x] iOS 7.1+

## Download + Setup

### Download

  * [Stable release](https://github.com/hansemannn/ti.paypal/releases)

### Setup

Unpack the module and place it inside the `modules/iphone/` folder of your project.

Edit the modules section of your `tiapp.xml` file to include this module:

```xml

    ti.paypal

```

Integrate the following snippet in your tiapp.xml. It is used to enable 1Password support

that is used by the PayPal-SDK:

```xml

    

        

            LSApplicationQueriesSchemes

            

                com.paypal.ppclient.touch.v1

                com.paypal.ppclient.touch.v2

                org-appextension-feature-password-management

            

        

    

```

Initialize the module by setting the PayPal credentials which you can get from [here](https://developer.paypal.com).

```javascript

var PayPal = require('ti.paypal');

PayPal.initialize({

    clientIdSandbox: 'YOUR_CLIENT_ID_SANDBOX',

    clientIdProduction: 'YOUR_CLIENT_ID_PRODUCTION',

    environment: PayPal.ENVIRONMENT_SANDBOX // or: ENVIRONMENT_PRODUCTION, or: ENVIRONMENT_NO_NETWORK

});

```

## Features

### Simple Payment

A simple payment is used for do instant payments with items you define. Watch the events for updates on your transaction.

```js

var item1 = PayPal.createPaymentItem({

    name: 'My item',

    price: 23.99,

    sku: 'my-item',

    quantity: 1,

    currency: 'USD' // Any ISO-4217

});

var configuration = PayPal.createConfiguration({

    locale: 'en', // Any ISO 639-1

    merchantName: 'John Doe',

    merchantPrivacyPolicyURL: 'https://google.com',

    merchantUserAgreementURL: 'https://google.com',

    defaultUserEmail: '[email protected]',

    defaultUserPhoneNumber: '+1 111 222 333',

    defaultUserPhoneCountryCode: 'USD',

    acceptCreditCards: true,

    alwaysDisplayCurrencyCodes: false

    disableBlurWhenBackgrounding: false,

    presentingInPopover: false,

    forceDefaultsInSandbox: false,

    sandboxUserPassword: 'paypal_yeeey',

    sandboxUserPin: '1337',

    payPalShippingAddressOption: PayPal.PAYPAL_SHIPPING_ADDRESS_OPTION_NONE, // or *_PROVIDED, *_PAYPAL, *_BOTH

    rememberUser: false,

    disableShakeAnimations: false

});

var payment = PayPal.createPayment({

    // Required

    configuration: configuration, // Required payment configuration

    currencyCode: 'USD', // Required currency code (ISO)

    shortDescription: 'Your shopping trip at FooBar', // Required short description

    amount: 23.99, // Required amount, has to match the amount of your items if you set them

    items: [ item1 ] // Optional number of items

    intent: PayPal.PAYMENT_INTENT_SALE, // or PAYMENT_INTENT_AUTHORIZE or PAYMENT_INTENT_ORDER

    softDescriptor: 'This will appear in the credit card statement', // Optional credit-card statement description

    custom: 'my_custom_value', // Optional field, e.g. for tracking numbers

    invoiceNumber: 'IV101', // Optional invoice number

    payeeEmail: '[email protected]', // Optional third-party receiver for single payments.

    bnCode: 'THE_CODE' // Optional Build Notation code ("BN code"), from [email protected],

    shippingAddress: { // Optional shipping address

        recipientName: 'Tim Travel', // required

        line1: 'My St. 1337', // required

        city: 'San Jose', // required

        line2: 'Apt 3a'

        state: 'NYC',

        postalCode: '10001',

        countryCode: 'US'

    },

    paymentDetails: { // Optional payment details

        subtotal: 0.01,

        shipping: 23.98,

        tax: 0.0

    }

});

payment.addEventListener('paymentDidCancel', function(e) {

    Ti.API.warn('paymentDidCancel');

});

payment.addEventListener('paymentWillComplete', function(e) {

    Ti.API.warn('paymentWillComplete');

    Ti.API.warn(e.payment);

});

payment.addEventListener('paymentDidComplete', function(e) {

    Ti.API.warn('paymentDidComplete');

    Ti.API.warn(e.payment);

});

payment.show();	

```

### Future Payment

A future payment is used to ask the buyer for the permission to charge his account later.

```javascript

var configuration = PayPal.createConfiguration({

    merchantName: 'John Doe',

    merchantPrivacyPolicyURL: 'https://google.com',

    merchantUserAgreementURL: 'https://google.com',

    locale: 'en'

    // See full configuration above

});

var payment = PayPal.createFuturePayment({

    configuration: configuration

});

payment.addEventListener('futurePaymentDidCancel', function(e) {

    Ti.API.warn('futurePaymentDidCancel');

});

payment.addEventListener('futurePaymentWillComplete', function(e) {

    Ti.API.warn('futurePaymentWillComplete');

    Ti.API.warn(e.payment);

});

payment.addEventListener('futurePaymentDidComplete', function(e) {

    Ti.API.warn('futurePaymentDidComplete');

    Ti.API.warn(e.payment);

});

payment.show();	

```

### Profile Sharing

Profile sharing is used to share a user profile by defining different scopes that can be authorized. Available Scopes:

- [x] SCOPE_FUTURE_PAYMENTS

- [x] SCOPE_PROFILE

- [x] SCOPE_OPEN_ID

- [x] SCOPE_PAYPAL_ATTRIBUTES

- [x] SCOPE_EMAIL

- [x] SCOPE_ADDRESS

- [x] SCOPE_PHONE

```javascript

var configuration = PayPal.createConfiguration({

    merchantName: 'John Doe',

    merchantPrivacyPolicyURL: 'https://google.com',

    merchantUserAgreementURL: 'https://google.com',

    locale: 'en'

    // See full configuration above

});

var profile = PayPal.createProfileSharing({

    configuration: configuration,

    scopes: [PayPal.SCOPE_PROFILE, PayPal.SCOPE_EMAIL]

});

profile.addEventListener('profileSharingDidCancel', function(e) {

    Ti.API.warn('profileSharingDidCancel');

});

profile.addEventListener('profileSharingWillLogIn', function(e) {

    Ti.API.warn('profileSharingWillLogIn');

    Ti.API.warn(e.authorization);

});

profile.addEventListener('profileSharingDidLogIn', function(e) {

    Ti.API.warn('profileSharingDidLogIn');

    Ti.API.warn(e.authorization);

});

profile.show();

```

## Example

For a full example covering all API's, check the demo in `iphone/example/app.js`.

## Author

Hans Knoechel ([@hansemannnn](https://twitter.com/hansemannnn) / [Web](http://hans-knoechel.de))

## License

Apache 2.0

## Contributing

Code contributions are greatly appreciated, please submit a new [pull request](https://github.com/hansemannn/titanium-paypal/pull/new/master)!