Javascript

Example with billing_address:

Installation

You will need to include the SDK dependency payment_sdk_stable.min.js into your webpage specifying "UTF-8" like charset.

<!-- PG JS SDK -->
<script src="https://cdn.paymentez.com/ccapi/sdk/payment_sdk_stable.min.js" charset="UTF-8"></script>

Usage

Generate tokenization reference

Our library allows to you implement the easiest way a form to tokenize cards with us. Our form is dynamic and response for each card, that's mean, you only implement this form for any card type that we support.

You can implement following the next steps: 1. Create an element to contain the dynamic form. 2. Instance the PaymentGateway with the required parameters. 3. Generate the tokenization reference with the required data. generate_tokenize 4. Define the event to execute the tokenize action.

You only need to create a container and declare when you need that it will be inserted with a dynamic form with all required validations to capture the sensitive data.

<!-- Container styling example -->
<style>
  #payment_example_div {
    max-width: 600px;
    min-width: 400px;
    margin: 10 auto;
  }

  #payment_example_div > * {
    margin: 10 auto;
  }

  .tok_btn:hover {
    cursor: pointer;
  }

  .tok_btn:disabled, #tok_btn[disabled] {
    opacity: .65;
    cursor: not-allowed;
  }

  .tok_btn {
    background: linear-gradient(to bottom, rgba(140, 197, 65, 1) 0%, rgba(20, 167, 81, 1) 100%); /* W3C, IE10+, FF16+, Chrome26+, Opera12+, Safari7+ */
    color: #fff;
    width: 80%;
    border: 1px solid rgba(46, 86, 153, 0.0980392);
    border-bottom-color: rgba(46, 86, 153, 0.4);
    border-top: 0;
    border-radius: 4px;
    font-size: 17px;
    text-shadow: rgba(46, 86, 153, 0.298039) 0px -1px 0px;
    line-height: 34px;
    -webkit-font-smoothing: antialiased;
    font-weight: bold;
    display: block;
  }

  #retry_btn {
    display: none;
  }
</style>

<!--1. Create an element to contain the dynamic form.-->
<div id='payment_example_div'>
  <div id='tokenize_example'></div>
  <div id="response"></div>
  <button id='tokenize_btn' class='tok_btn'>Save card</button>
  <button id='retry_btn' class='tok_btn' display='none'>Save new card</button>
</div>

<!-- In this example, the form loads with the page, you can custom with the event you need. -->
<script>
  // Execute immediately
  (function () {
    // === Variable to use ===
    let environment = 'stg';
    let application_code = 'APP-CODE-CLIENT';  // Provided by Payment Gateway
    let application_key = 'app_key_client';  // Provided by Payment Gateway
    let submitButton = document.querySelector('#tokenize_btn');
    let retryButton = document.querySelector('#retry_btn');
    let submitInitialText = submitButton.textContent;

    // Get the required additional data to tokenize card
    let get_tokenize_data = () => {
      let data = {
        locale: 'en',
        user: {
          id: String(Math.floor((new Date).getTime() / 1000)),
          email: 'jhon@doe.com',
        },
        configuration: {
          default_country: 'COL'
        },
      }
      return data
    }

    // === Required callbacks ===
    // Executed when was called 'tokenize' function but the form was not completed.
    let notCompletedFormCallback = message => {
      document.getElementById('response').innerHTML = `Not completed form: ${message}, Please fill required data`;
      submitButton.innerText = submitInitialText;
      submitButton.removeAttribute('disabled');
    }

    // Executed when was called 'tokenize' and the services response successfully.
    let responseCallback = response => {
      // Example of success tokenization.
      //   {
      //    "card": {
      //     "bin": "411111",
      //     "status": "valid",
      //     "token": "2508629432271853872",
      //     "message": "",
      //     "expiry_year": "2033",
      //     "expiry_month": "12",
      //     "transaction_reference": "RB-143809",
      //     "type": "vi",
      //     "number": "1111"
      //   }
      // }

      // Example of failed tokenization. The error format is always the same, only the value of type, help, description changes.
      // {
      //    "error": {
      //       "type": "Card already added: 2508629432271853872",
      //       "help": "If you want to update the card, first delete it",
      //       "description": "{}"
      //    }
      // }
      document.getElementById('response').innerHTML = JSON.stringify(response);
      retryButton.style.display = 'block';
      submitButton.style.display = 'none';
    }

    // 2. Instance the [PaymentGateway](#PaymentGateway-class) with the required parameters.
    let pg_sdk = new PaymentGateway(environment, application_code, application_key);

    // 3. Generate the tokenization form with the required data. [generate_tokenize](#generate_tokenize-function)
    // At this point it's when the form is rendered on page.
    pg_sdk.generate_tokenize(get_tokenize_data(), '#tokenize_example', responseCallback, notCompletedFormCallback);

    // 4. Define the event to execute the [tokenize](#tokenize-function) action.
    submitButton.addEventListener('click', event => {
      document.getElementById('response').innerHTML = '';
      submitButton.innerText = 'Card Processing...';
      submitButton.setAttribute('disabled', 'disabled');
      pg_sdk.tokenize();
      event.preventDefault();
    });
    // };

    // You can define a button to create a new form and save new card
    retryButton.addEventListener('click', event => {
      // re call function
      submitButton.innerText = submitInitialText;
      submitButton.removeAttribute('disabled');
      retryButton.style.display = 'none';
      submitButton.style.display = 'block';
      pg_sdk.generate_tokenize(get_tokenize_data(), '#tokenize_example', responseCallback, notCompletedFormCallback);
    });

  })();

</script>

PaymentGateway Class

Contain all functionality to connect with the Payment Gateway and must be instanced with the following parameters:

Field	Description	Type	Required
Environment	Environment to operate (stg, prod)	String	X
Application Code	Provided by the Payment Gateway	String	X
Application Key	Provided by the Payment Gateway	String	X

Generate Tokenize function

Execute this function to generate the dynamic form, and insert within the specified container. Call with the following parameters:

Field	Description	Type	Required
Tokenize data		Object	X
Container query selector	Query selector by identify the html element	String	X
Response callback	Callback to receive the token	function	X
Incomplete form callback	Callback to execute when the tokenize is requested, but the form is incomplete	function	X

Tokenize function

Execute this function to request the tokenize, this function validate by default all data set by the client in the form. In case the data is incomplete or incorrect, the incomplete form callback will be invoked.

Tokenize Data

    let tokenize_data = {
      locale: 'en',
      user: {
        id: '117',
        email: 'jhon@doe.com',
      },
      configuration: {
        default_country: 'COL',
      }
    }

Field	Description	Type	Required
locale	Language to use (pt, es, en)	String
user.id	Customer identifier. This is the identifier you use inside your application	String	X
user.email	Buyer email, with valid e-mail format	String	X
configuration.default_country	Country in format ISO 3166-1 Alpha 3	String
configuration.icon_colour	Icons color	String
configuration.use_dropdowns	Use dropdowns to set the card expiration date	String
configuration.exclusive_types	Define allowed card types	String
configuration.invalid_card_type_message	Define a custom message to show for invalid card types	String
configuration.require_billing_address.	Use billing address	Boolean
configuration.require_cellphone.	Use phone number	Boolean

What is 3DS2 and how it works

3D Secure 2 is the new generation of authentication technology introduced by EMVCo, a company which is collectively owned by American Express, Discover, JCB, MasterCard, UnionPay and Visa. This technology enable cardholders to authenticate themselves with their card issuer while making card-not-present (CNP) online purchases.

The new specification includes:

•  Supports specific app-based purchases on mobile and other consumer devices
•  Improves the consumer experience by enabling intelligent risk-based decisioning that encourages frictionless consumer authentication
•  Delivers industry leading security features
•  Specifies use of multiple options for step-up authentication, including one-time passcodes, as well as biometrics via out-of-band authentication
• Enhances functionality that enables merchants to integrate the authentication process into their checkout experiences, for both app and browser-based implementations
• Offers performance improvements for end-to-end message processing
• Adds a non-payment message category to provide cardholder verification details to support various non-payment activities, such as adding a payment card to a digital wallet.

Unlike the previous version where shoppers are redirected to another site, in 3D Secure 2 the card issuer performs the authentication within your app or payment form. The issuing bank may verify the shopper’s identity using passive, biometric, and two-factor authentication approaches.

A transaction may go through a passive frictionless authentication flow or a challenge authentication flow where the issuer requires further interaction with a shopper.

Frictionless flow

In a frictionless flow, the acquirer, issuer, and card scheme exchanges all necessary information in the background through passive authentication using the shopper’s device fingerprint.

In your integration, you will need to get the 3D Secure 2 device fingerprint and if it is validated and approved by the issuer, the transaction is completed without further shopper interaction. (Steps 1-4 at the figure below)

Challenge flow

In the challenge flow the issuer requires additional shopper interaction for verification, either through biometrics, two-factor authentication, or similar methods.

In 3DS 2.0 the result of challenge is communicated through the DS. (Step 6 at the figure below) Thus, Merchant is informed about the authentication results via a separate channel, which is more secure.

Authentication only integration

We support 3D Secure 2 authentication for web and in-app transactions with your online payments integration.

It’s possible to perform  only the authentication.

In case of mobile, we have SDKs (Android and iOS) certificated by EMVCo, both SDKs will perform the challenge flow if needed:

For more information visit the API documentation for this case.

In a web-based integration, the flow is different:

For more information visit the API documentation for this case.

Payment with 3DS2 authentication

In this type of integration,  we will perform the authentication and proceed with the payment.

The payment could be done throw the different end points we provide, depending on the country or the type or integration. The possibles end points are: Add a card , Debit with token , Debit with credit card and Authorize

For the Add card flow, the authentication will be performed before adding  the card in our vault.

For the SDKs in Android or iOS, the flow is the following:

In a web-based integration, the flow is different:

A 3DS authentication flow starts with a payment request. Send a payment request from your server with the required 3D Secure 2 objects.

Handle the transaction based on the obtaining Status and Status detail. For example, if you received an Status Pending and Status detail 35, proceed to render the hidden iframe provided in the response,  and then submit the verify.

The possible responses after you submit the verify are:

• Success: This means the authentication was frictionless and the payment has been authorised.
• Pending: The issuer requires additional shopper interaction. Proceed to the challenge flow.
• Failure: The authentication was refused or something went wrong. This response includes a refusal reason.

 

Wallet

Visa Checkout

Paymentez is a Visa Checkout partner.

Visa Checkout can enhance payment acceptance online by giving shoppers the convenience of storing payment information behind a single log in – that means they can pay without entering their shipping and account information every time.

For further information visit:

Instructions to use Visa Checkout with Paymentez

Master Pass

Simple, secure payments from one account.

No typing in your card number or shipping address. Sign up for Masterpass for faster checkout when shopping on a website, in an app, or at your favorite store using your secured payment details.

For further information visit:

Instructions to use Master Pass  with Paymentez

Bank Ticket

Users print out a receipt and go to a bank or point of sale to pay in cash. Approval takes up to 48 hours after payment.

Coming soon…

Bank Transfer

Users make a wire transfer from their bank account. Approval may take up to 72 hours.

For Colombia  we make bank transfers thru PSE. The steps are:

1. First you need to consult the list of available  banks.
2. Then generate bank transfer, in this step we return the bank URL.
3. The payer must be redirected to the *bank URL* returned in above step.
4. When the payer completes the transaction in the virtual office of his bank, he will be redirected to the url that was provided in the creation of the transaction response_url.
5. Once the client returns to your platform, you must check the status of the transaction so that PSE closes the transaction and returns the final status. You will get the final status of the transaction in this last service and also through the webhook.

Cash Payment

Users generate a reference to pay in an institution, with which they have an agreement.

For Colombia  we generate cash payment reference which can be done in an institution with which there is an agreement (baloto, efecty, dimonex, puntored, redservi).

For Ecuador we generate cash payment reference (CIP), via PagoEfectivo. More information

The steps are:

1. Generate a reference.
2. Wait for the final customer to make the payment.

Tuya Cards

We have a parnership with Tuya, these is a quick start flow.

• Add Card and Payment flow

• Add Card, you must use our javascript then you will get a card.token, card.status, transaction.id and other information, if the client have clave temporal or clave with hard authentication the card.status will be pending( go to step 2) otherwise could be active so go to step 5.
• If the card.status is pending the card.message should have a json with email or cell phone, then you should show one of the following messages to your client.

  Message with phone and email:

  We sent a temporary code to your cell phone {phone} and your email {email} with a validity of one minute, please enter it when you receive it. If this is not your cell phone number or email you must update your personal data at the service centers of your financial entity.

  Message only with email:

  We sent a temporary code to your email {email} with a validity of one minute, please enter it when you receive it. If this is not your email you must update your personal data at the service centers of your financial entity.

  Message only with phone:

  We sent a temporary code to your cell phone {phone} with a validity of one minute, please enter it when you receive it. If this is not your cell phone number you must update your personal data at the service centers of your financial entity.

• Now the client must confirm the clave temporal,  so you need to implement the endpoint verify in order to activate the card.
• On the response you will know if the card is ready for use.
• Once the card is ready you can use it for debit method (here you will need the card.token from point 1).
• Like step 2 depending of the card authentication you will get a status and status detail, use them to know if you need to verify the transaction or not.

Spreedly

Paymentez is one of the payment gateways Spreedly supports.

For more information visit:  Quit guide

Paymentez PHP SDK

Installation

Install via composer (not hosted in packagist yet)

composer require paymentez/sdk

 Usage

<?php

require 'vendor/autoload.php';

use Paymentez\Paymentez;

// First setup your credentials provided by paymentez
$applicationCode = "SOME_APP_CODE";
$applicationKey = "SOME_APP_KEY";

Paymentez::init($applicationCode, $applicationKey);

Once time are set your credentials, you can use available resources.

Resources availables:

• Card Available methods: getList, delete
• Charge Available methods: create, authorize, capture, verify, refund
• Cash Available methods: generateOrder

 Card

See full documentation of these features here.

List

<?php

use Paymentez\Paymentez;
use Paymentez\Exceptions\PaymentezErrorException;

Paymentez::init($applicationCode, $aplicationKey);

$card = Paymentez::card();

// Success response
$userId = "1";
$listOfUserCards = $card->getList($userId);

$totalSizeOfCardList = $listOfUserCards->result_size;
$listCards = $listOfUserCards->cards;

// Get all data of response
$response = $listOfUserCards->getData();

// Catch fail response
try {
    $listOfUserCards = $card->getList("someUID");
} catch (PaymentezErrorException $error) {
    // Details of exception
    echo $error->getMessage();
    // You can see the logs for complete information
}

Charges

See full documentation of these features here.

Create new charge

See full documentation about this here

<?php

use Paymentez\Paymentez;
use Paymentez\Exceptions\PaymentezErrorException;

// Card token
$cardToken = "myAwesomeTokenCard";

$charge = Paymentez::charge();

$userDetails = [
    'id' => "1", // Field required
    'email' => "cbenavides@paymentez.com" // Field required
];

$orderDetails = [
    'amount' => 100.00, // Field required
    'description' => "XXXXXX", // Field required
    'dev_reference' => "XXXXXX", // Field required
    'vat' => 0.00 // Field required 
];

try {
    $created = $charge->create($cardToken, $orderDetails, $userDetails);
} catch (PaymentezErrorException $error) {
    // See the console output for complete information
    // Access to HTTP code from paymentez service
    $code = $error->getCode();
    $message = $error->getMessage();
}

// Get transaction status
$status = $created->transaction->status;
// Get transaction ID
$transactionId = $created->transaction->id;
// Get authorization code
$authCode = $created->transaction->authorization_code;

Authorize charge

See the full documentation here

<?php

use Paymentez\Paymentez;
use Paymentez\Exceptions\PaymentezErrorException;

// Card token
$cardToken = "myAwesomeTokenCard";

$charge = Paymentez::charge();

$userDetails = [
    'id' => "1", // Field required
    'email' => "cbenavides@paymentez.com" // Field required
];

$orderDetails = [
    'amount' => 100.00, // Field required
    'description' => "XXXXXX", // Field required
    'dev_reference' => "XXXXXX", // Field required
    'vat' => 0.00 // Field required 
];

try {
    $authorization = $charge->authorize($cardToken, $orderDetails, $userDetails);
} catch (PaymentezErrorException $error) {
    // See the console output for complete information
    // Access to HTTP code from paymentez service
    $code = $error->getCode();
    $message = $error->getMessage();
}

// Get transaction status
$status = $authorization->transaction->status;
// Get transaction ID
$transactionId = $authorization->transaction->id;
// Get authorization code
$authCode = $authorization->transaction->authorization_code;

Capture

See the full documentation here

Need make a authorization process

<?php

use Paymentez\Paymentez;
use Paymentez\Exceptions\PaymentezErrorException;

$charge = Paymentez::charge();

$authorization = $charge->authorize($cardToken, $orderDetails, $userDetails);
$transactionId = $authorization->transaction->id;

try {
    $capture = $charge->capture($transactionId);
} catch (PaymentezErrorException $error) {
    // See the console output for complete information
    // Access to HTTP code from paymentez service
    $code = $error->getCode();
    $message = $error->getMessage();
}

// Get transaction status
$status = $capture->transaction->status;

// Make a capture with different amount
$newAmountForCapture = 1000.46;
$capture = $charge->capture($transactionId, $newAmountForCapture);

Refund

See the full documentation here

Need make a create process

<?php

use Paymentez\Paymentez;
use Paymentez\Exceptions\PaymentezErrorException;

$charge = Paymentez::charge();

$created = $charge->create($cardToken, $orderDetails, $userDetails);
$transactionId = $created->transaction->id;

try {
    $refund = $charge->refund($transactionId);
} catch (PaymentezErrorException $error) {
    // See the console output for complete information
    // Access to HTTP code from paymentez service
    $code = $error->getCode();
    $message = $error->getMessage();
}

// Get status of refund
$status = $refund->status;
$detail = $refund->detail;

// Make a partial refund
$partialAmountToRefund = 10;
$refund = $charge->refund($transactionId, $partialAmountToRefund);

 Cash

Generate order

See the all available options in here

<?php

use Paymentez\Paymentez;
use Paymentez\Exceptions\PaymentezErrorException;

$cash = Paymentez::cash();

$carrierDetails = [
    'id' => 'oxxo', // Field required
    'extra_params' => [ // Depends of carrier, for oxxo is required
        'user' => [ // For oxxo is required
            'name' => "Juan",
            'last_name' => "Perez"
        ]
    ]
];

$userDetails = [
   'id' => "1", // Field required
   'email' => "randm@mail.com" // Field required
];

$orderDetails = [
    'dev_reference' => "XXXXXXX", // Field required 
    'amount' => 100, // Field required
    'expiration_days' => 1, // Field required
    'recurrent' => false, // Field required
    'description' => "XXXXXX" // Field required
];

try {
    $order = $cash->generateOrder($carrierDetails, 
    $userDetails, 
    $orderDetails);
} catch (PaymentezErrorException $error) {
    // See the console output for complete information
    // Access to HTTP code from paymentez service
    $code = $error->getCode();
    $message = $error->getMessage();
}

// Get reference code
$referenceCode = $order->transaction->reference;
// Get expiration date
$expirationData = $order->transaction->expiration_date;
// Get order status
$status = $order->transaction->status;

Run unit tests

composer run test

Magento 2

If already have your e-commerce platform on Magento 2 we have the module for using our payments solutions.

How to install the Paymentez module for Magento 2

This module is a solution that allows Magento users to easily process payments with Paymentez.

Download and Installation

1. Execute this command for install our package:

Install the latest version. composer require paymentez/payment-gateway

Install a specific version. composer require paymentez/payment-gateway:2.3.1

Once the installation finished, continue with the next commands in your bash terminal.

2. Update dependency injection:

php bin/magento setup:di:compile

3. Update modules registry:

php bin/magento setup:upgrade

Optional.- This command is optional for production environments:

php bin/magento setup:static-content:deploy

Now you can see the Paymentez settings in this path Stores > Configuration > Sales > Payment Methods on your Magento admin dashboard.

Maintenance

If you need update the plugin to latest version execute: composer update paymentez/payment-gateway or composer require paymentez/payment-gateway:2.3.1 for specific version.

Webhook Notifications and Order Updates

Every time a transaction changes their status you will get an HTTP POST request from Paymentez to your webhook.

The URL that will be used for the order updates via webhook is: https://magentodomain.com/rest/V2/webhook/paymentez

This URL will be configured on Paymentez.

The Magento 2 configuration should look like this:

Configuration for LinkToPay:

Paymentez Payment Gateway Plugin for WooCommerce

Paymentez Payment Gateway Plugin for WooCommerce

Download latest version on GitHub

This is a WordPress plugin that integrates the Paymentez payment gateway into WooCommerce, offering two independent payment methods:

Paymentez Checkout: Payments with credit/debit cards through a secure modal using the official Paymentez SDK.

Paymentez Link to Pay: Hosted payment link that redirects the customer to the Paymentez platform, with support for PSE, cash, digital wallets and more.

Requirements

• WordPress 6.5 or higher
• WooCommerce 8.0 or higher
• PHP 7.4 or higher (compatible with PHP 8.x)

1.- Prerequisites

1.1.- XAMPP, LAMPP, MAMPP, Bitnami or any PHP development environment

• XAMPP: https://www.apachefriends.org/download.html
• LAMPP: https://www.apachefriends.org/download.html
• MAMPP: https://www.mamp.info/en/mac/
• Bitnami: https://bitnami.com/stack/wordpress

1.2.- Wordpress

If you already installed the Bitnami option, this step can be omitted.

The documentation necessary to install and configure Wordpress is found at the following link:

https://wordpress.org/support/article/how-to-install-wordpress/

All minimum requirements (PHP and MySQL) must be met for the developed plugin to work correctly.

1.3.- WooCommerce

The documentation needed to install WooCommerce is found at the following link:

https://docs.woocommerce.com/document/installing-uninstalling-woocommerce/

There you will also find the information necessary to troubleshoot installation-related issues.

1.4.- WooCommerce Admin

The documentation needed to install WooCommerce Admin is found at the following link:

https://wordpress.org/plugins/woocommerce-admin/

There you will also find the information necessary to troubleshoot installation-related issues.

2.- Git Repository

You can download the current stable version from: https://github.com/paymentez/pg-woocommerce-plugin/releases

3.- Plugin Installation

The development works as a WordPress plugin that connects to another WordPress plugin, WooCommerce.

So when it is installed and activated, WooCommerce and WordPress hooks and actions are used.

3.1 Installation and Activation Through WordPress Admin

When we have the project compressed in .zip format, we proceed to the installation through WordPress Admin.

1. The first step will be to log in to WordPress Admin as an administrator.

2. Being in the main screen of the administrator, we click on the Plugins tab.

   

3. Within the Plugins screen, we click on Add New.

   

4. Within the Add Plugins screen, we click on Upload Plugin.

5. The option to upload our plugin in .zip format will be displayed. We upload it and click the Install Now button.

   

6. We will be redirected to the plugin installation screen. We wait for the message "Plugin installed successfully" and click the Activate Plugin button.

7. We will be redirected to the Plugins screen where we will see our plugin installed and activated.

3.2. Languages

The plugin language is selected dynamically according to the language configured in WordPress. Available languages are:

• English (Default)
• Spanish
• Portuguese

4.- Activation and Configuration of the Plugin in WooCommerce

After installing the plugin in WordPress, we must proceed to configure it in the WooCommerce administrator. The plugin registers two independent payment methods that must be enabled and configured separately.

We navigate to WooCommerce → Settings → Payments where we will see both detected and installed methods: Paymentez Checkout and Paymentez Link to Pay.

4.1 Activation of Payment Gateways

For each payment method, we enable the Enable button on the WooCommerce Payments screen. This enablement is independent of the plugin activation in WordPress that we performed earlier.

4.2 Configuration of Paymentez Checkout (Card Payment)

We click on Manage next to Paymentez Checkout.

The options to configure are:

• Enable/Disable: Activates this payment method at the checkout of the store.

• Environment: Select Staging (testing) or Production. In Staging the plugin will point to Paymentez's test server.

• Title: Text that the customer will see next to the payment method in the checkout.

• Description: Message that the customer will see when selecting this payment method.

• Button Text: Text to be displayed on the payment button of the modal.

• App Code: Unique identifier provided by Paymentez.

• App Key: Key used to encrypt communication with Paymentez.

4.3 Configuration of Paymentez Link to Pay

We click on Manage next to Paymentez Link to Pay. The options to configure are:

• Enable/Disable: Activates this payment method at the checkout of the store. Supports PSE, cash, digital wallets and bank transfers.

• Environment: Select Staging (testing) or Production.

• Title: Text that the customer will see next to the payment method in the checkout.

• Description: Message that the customer will see when selecting this payment method.

• App Code: Unique identifier provided by Paymentez.

• App Key: Key used to encrypt communication with Paymentez.

5.- Select the Plugin in the Store Checkout

When we have our plugin activated and configured in WooCommerce, we will see it available to be selected by customers on the Checkout page of our store.

Simply select it, complete the Billing Details and click the Place Order button.

Clicking on it will take us to the Order-Pay or Pay For Order window where we will see a summary of our order. The Pay with Card and/or Pay with Cash/Bank Transfer button will be displayed, which will open the payment process.

6.- Process to Make a Refund

The refund process will begin in the main WordPress administration window.

We select the WooCommerce tab and click on the Orders option.

We select the order we want to refund and the Edit Order window will open.

In the item detail we will find the Refund button, we click it and the refund options will be displayed.

We type the amount to refund and click the Refund via Paymentez button. The status within WooCommerce will change and so will the status at the gateway.

7.- Webhook Configuration

The plugin includes a webhook endpoint to receive transaction notifications from Paymentez and automatically update order statuses in WooCommerce. Validation is performed using HMAC-SHA256.

To configure it, the merchant must register the webhook URL in the Paymentez panel. The URL follows the following format:

https://{{URL-COMMERCE}}/wp-json/paymentez/webhook/v1/params

Note: If the site uses plain permalinks, use the following alternative format:

https://{{URL-COMMERCE}}/?rest_route=/paymentez/webhook/v1/params

VTEX

We have implemented the solution eCommerce VTEX + Paymentez

How to configure Paymentez v2

For these instructions, it is assumed that the VTEX administrator on behalf of the merchant is well acquainted with the admin panel.

Follow the following steps:

1. Enter the payment configuration section.
   

2. Select the Gateway Affiliations tab and add one by clicking the plus button.

   

3. Within the alphabetically ordered OTHERS list, search for the connector named PaymentezV2.

   

4. Once the connector is selected, you must configure it, where Application Key is the Application Code provided by Paymentez and the Application Token is the Application Key provided by Paymentez. You can specify there the environment you want to point to, with Live/Production for production environment and Test for staging environment. It should look like this:

   

5. Once the affiliation is configured, it can be assigned for the payment method that the administrator selects.

How to configure Paymentez v2 for an established franchise

Keep in mind that when assigning the affiliation to an established franchise, ALL transactions with that franchise will be processed with Paymentez.

1. Enter the payment configuration section.

2. In the Payment Conditions tab, add a new condition by clicking the plus button.

   

3. Select the franchise you want to process with Paymentez

   

4. Once the franchise is selected, you must assign a name to the condition and select the PaymentezV2 affiliation

   

5. Regarding whether to select full payment or installment payments, this is at the discretion and knowledge of the VTEX administrator of the merchant.

How to configure Paymentez v2 for Cash

Keep in mind that when assigning the affiliation to an established franchise, ALL transactions with that franchise will be processed with Paymentez.

1. Enter the payment configuration section.

2. In the Payment Conditions tab, add a new condition by clicking the plus button.

   

3. Within OTHER exists the Cash option, select this

   

4. Select the configured Paymentez affiliation.
5. Regarding assigning special conditions for payment, this is at the discretion and knowledge of the VTEX administrator of the merchant.

How to configure Paymentez v2 for PSE (Colombia Only)

PSE is a payment method that does not appear within the existing VTEX options, so it is necessary to create it through a Promissories.

1. Enter the payment configuration section.

2. In the Custom Payments tab, add a new condition by clicking a Config checkbox.

   

3. Within the configuration, you must assign the name PSE (this name is completely required as it is used to identify the payment method by the connector). In expiration time, 2 is required, since on the Paymentez side two days are given for the end customer to pay. The data should look like what is shown in the image.

   

4. Select the configured Paymentez affiliation.

   

5. Regarding assigning special conditions for payment, this is at the discretion and knowledge of the VTEX administrator of the merchant.

How to configure Paymentez v2 for LinkToPay

LinkToPay is a payment method that does not appear within the existing VTEX options, so it is necessary to create it through a Promissories.

1. Enter the payment configuration section.

2. In the Custom Payments tab, add a new condition by clicking a Config checkbox.

   

3. Within the configuration, you must assign the name LinkToPay (this name is completely required as it is used to identify the payment method by the connector). In expiration time, 2 is required, since on the Paymentez side two days are given for the end customer to pay. The data should look like what is shown in the image.

   

4. Select the configured Paymentez affiliation.

   

5. Regarding assigning special conditions for payment, this is at the discretion and knowledge of the VTEX administrator of the merchant.

Paymentez Payment Gateway Plugin for Prestashop

Paymentez Payment Gateway Plugin for Prestashop

Download latest version on GitHub

This plugin integrates the Paymentez payment gateway into Prestashop.

Requirements

• PrestaShop 8.0.0 or newer (8.x and 9.x)
• PHP 7.4 or higher (compatible with PHP 8.x)
• Any PHP development environment such as XAMPP, LAMPP, MAMPP or Bitnami

1.- Prerequisites

1.1.- XAMPP, LAMPP, MAMPP, Bitnami or any PHP development environment

• XAMPP: https://www.apachefriends.org/download.html
• LAMPP: https://www.apachefriends.org/download.html
• MAMPP: https://www.mamp.info/en/mac/
• Bitnami: https://bitnami.com/stack/prestashop

1.2.- Prestashop

Warning, if you already install the Bitnami option this step can be omitted.

Prestashop is an e-commerce solution, it's developed on PHP. This plugin is compatible with PrestaShop 8.0.0 and newer (8.x and 9.x).

Download  |  Install Guide

2.- Git Repository

You can download the current stable release from: https://github.com/paymentez/pg_prestashop_plugin/releases

3.- Plugin Installation on Prestashop

1. First, we need to download the current stable release of Paymentez Prestashop plugin from the previous step.
2. We need to unzip the file to get the pg_prestashop_plugin-3.0.0 folder.
3. Now you rename the folder from pg_prestashop_plugin-3.0.0 to pg_prestashop_plugin.
4. Compress on zip format the folder to get a file called pg_prestashop_plugin.zip.
5. We need to log in to our Prestashop admin page.
6. Now we click on Modules -> Module Manager
7. In the Module manager we click on the Upload a module button
8. We click on select file, or we can drop the Paymentez Prestashop plugin archive in .zip format.
9. We will wait until the Installing module screen changes to Module installed!.
10. Now we can click on Configure button displayed on the screen or in the Configure button displayed on the Payment section on the Module manager.
11. Inside the Payment Gateway Configurations we need to configure the Server credentials provided by Paymentez, we can select the Checkout Language that will be displayed to the user, also we need to select an Environment, by default STG (Staging) is selected.
12. Congrats! Now we have the Paymentez Prestashop plugin correctly configured.

4.- Considerations and Comments

4.1.- Refunds

• The plugin supports Partial Refunds and Standard Refunds only for card payments. LinkToPay does not support refunds.
• The Standard Refund now uses the full paid order amount when Credit slip is selected in PrestaShop. Partial refunds still use the selected products and shipping amount. A success refund operation depends on the configured payment network accepting refunds.

4.2.- Webhook

The Paymentez Prestashop plugin has an internal webhook in order to keep updated the transactions statuses between Prestashop and Paymentez. You need to follow the next steps to configure the webhook:

1. Login into the Prestashop Back-office.
2. Navigate to Advance Parameters -> Web Services menu options to open the Web Services page.
3. It will redirect to the Web Services page having the listing of available Webservices, and the configuration form to configure the service.
4. We need to enable the field called Enable Prestashop webservice.
5. Click on Save button.
6. The module creates the paymentezwebhook webservice key automatically during installation.
7. Edit that key in Advanced Parameters -> Web Services and manually enable POST permission for paymentezwebhook.
8. You can review/copy the generated key in that same screen.
9. The webhook is located on https://{mystoreurl}/api/paymentezwebhook?ws_key=THE_KEY_CREATED_BY_THE_MODULE.
10. You need to give this URL to your Paymentez agent.