Installation

Swift

To use the PixelPay SDK with Swift, it is necessary to include the corresponding library in the project through CocoaPods. To do this, the following dependencies must be included in the Podfile :

target 'MyApp' do
  pod 'PixelPaySDK'
end

In case the Podfile file does not exist, it will be necessary to create it.

Remember to replace the target with the name of your application.

Then, it is necessary to run the following command in the project:

$ pod install

This will create an xcworkspace file where you can work on the project. Once the development is finished, the project can be executed.

That's it! Now the PixelPay libraries are available in your Swift project.

For more information on the use of CocoaPods, click here

Android-Java

To obtain the SDK version with Java/Android:

Go to the path {project}/build.gradle and add the following in the repositories section:

allprojects {
  repositories {
    mavenCentral()
    maven { url 'https://jitpack.io' }
  }
}

The next step is to go to the path {project}/app/build.gradle and in the dependencies section add:

dependencies {
  implementation 'org.bitbucket.pixelpay:sdk-android:2.2.2'
}

That's it! You can now use the SDK in your project.

Flutter

To use the PixelPay SDK with Flutter automatically, it is necessary to run the following command in the terminal:

$ flutter pub add pixelpay_sdk

Settings required for Android:

In the path {project}/android/app/build.gradle you must change the minSdkVersion to 21.

dependencies {
  defaultConfig {
    minSdkVersion 21
  }
}

The next step is to go to the path {project}/android/app/src/main/AndroidManifest.xml add in the manifest section:

<manifest 
  ... xmlns:tools="http://schemas.android.com/tools">

And finally, in the application section add the following:

<application 
  ... tools:replace="label">

In case of error, try the manual mode.

Manual Mode

To use the PixelPay SDK with Flutter it is necessary to include the following dependency in the pubspec.yaml file:

dependencies:
  flutter:
    sdk: flutter
  pixelpay_sdk: ^2.0.0

Remember to correctly indent the dependencies you add to avoid compilation errors in your application.

Once the necessary dependencies are installed, it is necessary to run the following command in console:

$ flutter pub get

This way you get the latest versions of the added dependencies.

That's it! Now the PixelPay libraries are available in your Flutter project.

For more information on using libraries in Flutter, go here.

Ionic

The official NPM packages are @pixelpay/sdk-core and @pixelpay/capacitor-plugin.

Use the following commands for download and installation:

npm install @pixelpay/sdk-core
npm install @pixelpay/capacitor-plugin

Ionic/IOS integration

See the Ionic Official Documentation for more information.

Ionic/Android integration

See the Ionic Official Documentation for more information.

React Native

The official NPM packages are @pixelpay/sdk-core and @pixelpay/react-native-plugin.

Use the following commands for download and installation:

npm install @pixelpay/sdk-core
npm install @pixelpay/react-native-plugin

React Native/IOS integration

See the React Native Official Documentation for more information.

React Native/Android integration

See the React Native Official Documentation for more information.

JavaScript/TypeScript

The PixelPay SDK is available for JavaScript and TypeScript in different environments. This integration applies to JS frameworks including the most common Angular Vue and React versions.

This environment can be run in a browser. If the browser service is not available (Node.js), the SDK will not be able to run with 3DS.

Modular / Node

Click here to install the official NPM package:

npm install @pixelpay/sdk-core

If you are using React, Angular or Vue to develop your app, install the @pixelpay/sdk-core npm package .

Browser / CDN

To be able to use the SDK in Angular or Ionic/Angular it is recommended to use the CDN with Unpkg:

<script src="https://unpkg.com/@pixelpay/sdk-core"></script>

Place the script in the src/index.html file and declare a global SDK variable where the SDK service will be used.

HTML example with Angular:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Angular</title>
    <base href="/" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <link rel="icon" type="image/x-icon" href="favicon.ico" />
  </head>
  <body>
    <app-root></app-root>
    <!-- CDN SDK -->
    <script src="https://unpkg.com/@pixelpay/sdk-core"></script>
  </body>
</html>

PHP

Click here to install the official Composer package:

composer require pixelpay/sdk

Java Standalone

To obtain the SDK version with Java:

In the build.gradle file add the following in the repositories section:

allprojects {
  repositories {
    mavenCentral()
    maven { url 'https://jitpack.io' }
  }
}

In the dependencies section add:

dependencies {
  implementation 'org.bitbucket.pixelpay:sdk-java:2.2.1''
}

Python

To obtain the version of the Python 3 SDK it is necessary to install it at the following link:

pip install pixelpay-sdk

In case the requirements.txt file already exists inside the project, you can also add it to the dependencies list:

pixelpay-sdk>=2.2.0

.NET

To obtain the PixelPay SDK version with C# it is necessary to install the NuGet package.

To install the package, you can use the NuGet Package Manager or the Package Manager Console. Depending on the project format, installing a NuGet package records the dependency in the project file or in a packages.config file.

From the NuGet Package Manager

To use the NuGet package manager to install the PixelPaySDK package in Visual Studio, follow these steps:

In Visual Studio, select Project>Manage NuGet packages.
In the NuGet Package Manager window, select nuget.org as Package source.
In the Browse tab, search for pixelpaysdk, select PixelPaySDK from the list, and then select Install.
If you are prompted to verify the installation, select Accept.

From the Package Manager Console

Alternatively, to use the Package Manager Console in Visual Studio to install the PixelPaySDK package, follow these steps:

In Visual Studio, select Tools>NuGet Package Manager>Package Manager Console.
When the console opens, verify that the Package source drop-down list shows nuget.org and that the Default Project drop-down list shows the project into which you want to install the package. If you have only one project in the solution, it is already selected.
In the console command prompt, type the command:

Install-Package PixelPaySDK

The console window shows the output of the command.

Package source must be nuget.org.

From .NET CLI

To use the command console to install the PixelPaySDK package. You can run a Command Prompt or Windows PowerShell command console and navigate to your project to install the package, or you can follow these steps:

In Visual Studio, select Tools>Command Line>Developer Command Prompt or Tools>Command Line>Developer PowerShell.
Type the command:

dotnet add package PixelPaySDK

The console window shows the output of the command.

The above command is the one that should be executed, even if you have manually navigated to the project using the console.

Go

To obtain the PixelPay SDK version with Golang you can use this command:

go get bitbucket.org/pixelpay/sdk-go

Check the official documentation of this SDK here.

Ruby

To obtain the PixelPay SDK version with Ruby you need to install a gem.

You can add it to your project from the Gemfile file or install it with the gem command.

From Gemfile

Use the Gemfile file located at the root of the project source code:

Include the gem in the package list:

gem 'pixelpay_sdk', '1.0.1'

Run the following command in the terminal:

bundle install

From gem install

Run the following command in the terminal:

gem install pixelpay_sdk --pre

Verify the installation by running the following command:

gem list