SDKs

Introduction

The Addon Payments SDK is designed to provide an easy, fast, and flexible integration of payments into your e-commerce. With this SDK, you can integrate the Addon Payments gateway in various programming languages, using a variety of libraries, tools, and documentation.

The SDK allows you to implement our payment gateway in several ways: Hosted, Host2Host and JavaScript. In addition, you will be able to perform various operations: authorizations, recurring payments, etc., with different payment solutions: credit cards and Quix. See the Supported operations section for more details. You will also find libraries for receiving and processing notifications, as well as tools for cashier rendering and redirection.

The SDK gives you power along with a clear structure of classes and methods that make it easy to use. It also allows you to extend the functionality of the SDK by using functional operations, such as extra parameters to suit specific needs.

GitHub links to SDKs

These are the links to the SDKs on GitHub. You will find the documentation on how they work alongside the SDK. In the documentation, you can learn about the preliminary configuration steps according to the language and the running of the various operations.

PHP

JAVA

.NET icon

.NET

PYTHON

General requirements

In order to use the SDKs, your e-commerce or platform must have a public URL that serves as an endpoint, which will be responsible for receiving notifications, managing statuses, etc.

In addition, here are the general requirements for SDK use according to each language.

PHP:

  • Version 8.0 or higher.
  • We recommend using Composer.

.NET: 

  • Version 8.0 or higher.

Java:

  • If you use Gradle, the JDK version must be lower than 22.

Gradle

Edit your build.gradle file.

1. Add to the repositories section:

				
					maven { 
            url = System.getenv("CGP_JAVASDK_URL") ?: uri( 
"https://maven.pkg.github.com/DeveloperCGP/Java-SDK") 
        credentials { 
                username = System.getenv("CGP_JAVASDK_USERNAME") ?: "DeveloperCGP" 
                password = System.getenv("CGP_JAVASDK_TOKEN") ?: 
"ghp_AViip9V8DaJgu1tAzuz4dSpwXy8Hoe1ana8x" 
            } 
}

2. Add to the dependencies section the following line:

implementation("com.comerciaglobalpayments:java-sdk:01.00.00")

3. Build your project.

Maven

1. Add this to pom.xml

				
					<dependency>
    <groupId>com.comerciaglobalpayments</groupId>
    <artifactId>java-sdk</artifactId>
    <version>01.00.00</version>
</dependency>

2. Run via command line:

$ mvn install

Supported operations

In this section you will find the examples of supported operations in the SDK. All the operations in the documentation of the 3 types of integrations are supported by the SDK, but in the SDK you only have examples of the ones you can see below. We recommend that you check that the SDK works correctly by testing the unmodified examples.

With the SDK you can work with all integrations: Hosted, Host2Host and JavaScript.

Payments with credit cards

Hosted:

  • Authorization
  • Recurring payments registration

Host2Host:

  • Authorization
  • Pre-authorization
  • Recurring payments registration
  • Recurring payments
  • Capture
  • Voids
  • Refunds

JavaScript:

  • Obtaining the authToken
  • Authorization (charge)
  • Recurring payments registration

Pagos con Quix

Hosted:

  • Items
  • Services
  • Flights
  • Accommodations

    JavaScript:

    • Obtaining authToken
    • Items charge
    • Services charge
    • Flights charge
    • Accommodations charge

    Operation flow in the SDK

    In this section you will find the general flow that the operations follow in the SDK. This is a basic description, in the GitHub documentation you can see in detail the explanation of the different steps depending on the operation and programming language you are using.

    The general flow regardless of the integration, operation and programming language is as follows:

    1. Set the credentials: You set the credentials of your commerce in a common place only once, so that you can use them in different examples and operations. These data are necessary for any operation: merchantId, merchant password, productId, among others.

    2. Set payment parameters: You set the parameters that depend more on the operation you are performing (authorization, refund, etc.). These data vary from one type of operation to another, such as the amount or the customer identifier, among others.

    3. Sending the request: Sending the request with the credentials and payment parameters you have previously configured.

    4. Response management: You establish the handling of the response, such as obtaining the redirection URL for the client, the status of the transaction or possible errors.

    Remember that in the SDK you have a Webhook class that will help you receive and parse the notifications you receive from Addon Payments. See the GitHub documentation for more information.

    Comparte este documento
    Tabla de Contenidos

    Enlaces .NET

    Código fuente
    Repositorios de paquete

    Enlaces PYTHON

    Código fuente
    Repositorios de paquete

    Consulta la documentación de las distintas secciones de integraciones:

    Comienza a integrar

    undraw_add_to_cart_re_wrdo 1 (1) (1)

    Plugins para CMS

    Complementa la integración

    SDKs

    Métodos de pago

    Herramientas

    Addon Payments

    Consulta la documentación de Addon Payments. Aquí tienes las distintas secciones:

    Integraciones

    Consultas frecuentes

    Portal Backoffice

    Links .NET

    Source code
    Package repositories

    Cyberpac

    We are currently working on the English version of the Cyberpac documentation. You can view the Spanish version using the buttons below:

    Canales BackOffice Portal

    Plugins integration

    Custom integrations

    POS integrated Payments

    Create a solution that will help you automate processes. You can even add payment processes on physical terminals.

    Payment Integrated with Android POS

    Payment Integrated with Smartphone POS

    POS Data sheets

    Addon Payments

    Comercia Global Payments has several integration options so you can choose the most efficient one for you.

    Integrations

    Frequently Asked Questions

    BackOffice Portal

    Consult the documentation of the different integrations sections:​

    Start integration

    undraw_add_to_cart_re_wrdo 1 (1) (1)

    CMS Plugins

    Complement your integration

    SDKs

    Payment Methods

    Tools