Интеграция с префиксом PulPal

Подходит для интеграции где используются для платежей уникальные ID созданные на стороне Продавца. PulPal у себя на стороне добавляет префикс - это числовое или текстовое значение, которое используется на нашей стороне, чтобы Плательщик мог идентифицировать себя у терминала и использовать свой ID. Пример: ХХХ-1234(где ХХХ - это префикс, а 1234 уникальный ID в системе Продавца)

Тестовая и продуктовая среды

Система PulPal предоставляет тестовую среду для проверки интеграционных элементов. Параметры входа в тестовый аккаунт будут предоставлены посредством электронной почты; аккаунт для продуктовой среды будет создан во время заключения договора.

Меню (аватар) > Профиль компании
В разделе “Профиль компании” выберите вкладку “Настройки”. Здесь необходимо указать следующие параметры:

Описание запросов

Delivery

curl --location --request POST 'https://merchant.az/api/delivery' \
--header 'Signatire: 7bcP2M98mKku6W+KSurrkuyY3PGhiKsdzfrhjs85CIw=' \
--header 'Content-Type: application/json' \
--header 'Nonce: 1' \
--data-raw '{
    "price": "10000",
    "productType": 3,
    "externalId": "111111",
    "debt": 0,
    "amount": 2,
    "providerType": 1,
    "paymentAttempt": "df922726-c5c6-41c2-b2ff-dfac9022a473"
}'

var myHeaders = new Headers();
myHeaders.append("Signature", "7bcP2M98mKku6W+KSurrkuyY3PGhiKsdzfrhjs85CIw=");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Nonce", "510");

var raw = JSON.stringify({
  price: "10000",
  productType: 3,
  externalId: "111111",
  debt: 0,
  amount: 2,
  providerType: 1,
  paymentAttempt: "df922726-c5c6-41c2-b2ff-dfac9022a473",
});

var requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow",
};

fetch("https://merchant.az/api/delivery", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.log("error", error));

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://merchant.az/api/delivery',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "price": "10000",
    "productType": 3,
    "externalId": "111111",
    "debt": 0,
    "amount": 2,
    "providerType": 1,
    "paymentAttempt": "df922726-c5c6-41c2-b2ff-dfac9022a473"
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: 7bcP2M98mKku6W+KSurrkuyY3PGhiKsdzfrhjs85CIw=',
    'Content-Type: application/json',
    'Nonce': '1'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

require "uri"
require "net/http"

url = URI("https://merchant.az/api/delivery")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Signature"] = "7bcP2M98mKku6W+KSurrkuyY3PGhiKsdzfrhjs85CIw="
request["Content-Type"] = "application/json"
request["Nonce"] = "1"
request.body = "{\r\n    \"price\": \"10000\",\r\n    \"productType\": 3,\r\n    \"externalId\": \"111111\",\r\n    \"debt\": 0,\r\n    \"amount\": 2,\r\n    \"providerType\": 1,\r\n    \"paymentAttempt\": \"df922726-c5c6-41c2-b2ff-dfac9022a473\"\r\n}"

response = https.request(request)
puts response.read_body

The above command returns

200 - OK
401 - Unauthorized
400 - Bad Request

Check

curl --location --request POST 'https:/merchant.az/api/check' \
--header 'Signature: 7bcP2M98mKku6W+KSurrkuyY3PGhiKsdzfrhjs85CIw=' \
--header 'Content-Type: application/json' \
--header 'Nonce: 1' \
--data-raw '{
    "shortCode": "159674",
    "code": "PREFIX-159674",
    "separator": "-"
}'

var myHeaders = new Headers();
myHeaders.append("Signature", "7bcP2M98mKku6W+KSurrkuyY3PGhiKsdzfrhjs85CIw=");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Nonce", "1");

var raw = JSON.stringify({
  shortCode: "159674",
  code: "PREFIX-159674",
  separator: "/",
});

var requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow",
};

fetch("https:/merchant.az/api/check", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.log("error", error));

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https:/merchant.az/api/check',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "shortCode": "159674",
    "code": "PREFIX-159674",
    "separator": "-"
}',
  CURLOPT_HTTPHEADER => array(
    'Signature: 7bcP2M98mKku6W+KSurrkuyY3PGhiKsdzfrhjs85CIw=',
    'Content-Type: application/json',
    'Nonce: 1'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

require "uri"
require "net/http"

url = URI("https:/merchant.az/api/check")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Signature"] = "7bcP2M98mKku6W+KSurrkuyY3PGhiKsdzfrhjs85CIw="
request["Content-Type"] = "application/json"
request["Nonce"] = "1"
request.body = "{\r\n    \"shortCode\": \"159674\",\r\n    \"code\": \"PREFIX-159674\",\r\n    \"separator\": \"-\"\r\n}"

response = https.request(request)
puts response.read_body

The above command returns JSON structured like this:

{
  "name": {
    "az": "Test (az)",
    "ru": "Test (ru)",
    "en": "Test (en)"
  },
  "description": {
    "az": "Test (az)",
    "ru": "Test (ru)",
    "en": "Test (en)"
  },
  "debt": "200",
  "externalId": 23,
  "repeatable": false,
  "payMore": false,
  "payLess": false,
  "active": true,
  "signature": "",
  "signature2": ""
}

Зачем нужна подпись?

Замечания

ВНИМАНИЕ!

Зачем нужна подпись?

Метод Delivery необходим для уведомления Вашей системы о произведенной оплате.
Метод Check необходим для получения информации об оплачиваемой услуге в терминале оплаты или окне онлайн-оплаты (подробнее -- ниже). Пример кода продукта/услуги: XXX-012345

Здесь:
● XXX-012345 - это полный код продукта/услуги (Code)
● 012345 - короткий код продукта/услуги (ShortCode)
● XXX - префикс мерчанта. Устанавливается менеджерами PulPal по согласованию с мерчантом
● - - разделительный символ (Separator)

Данный код используется для оплаты пользователем в терминальной сети или для оплаты онлайн по следующей ссылке:

PaymentData — это строка в формате Base64, которая получается сериализацией JSON-объекта следующего содержания:

Зачем нужна подпись?

Замечание

Дополнительно в окне оплаты будет предоставлена возможности войти в систему или зарегистрироваться в ней (см. следующий скриншот).

Процесс оплаты состоит из следующих этапов:

1. Пользователь переходит в систему PulPal по ссылке, размещенной на вашем сервисе
   
2. Пользователь может произвести онлайн-оплату через сервис PulPal или же, получив уникальный код, произвести оплату посредством терминальных сетей
     a) После проведения онлайн-оплаты, пользователь будет перенаправлен на ссылку Redirect URL
   
3. После перенаправления на Redirect URL или оплаты посредством терминала, в системе PulPal начинается обработка платежа. После успешного завершения обработки, вызывается метод Delivery с вышеуказанными параметрам

Изменение страницы оплаты

Изменение языка страницы

По умолчанию, язык страницы оплаты определяется на основе настроек браузера. Однако, если возникает необходимость в отображении страницы оплаты на одном из трех поддерживаемых языков вне зависимости от настроек пользователя, то предлагается воспользоваться параметром lang, который принимает одно из трех значений: az, ru, en. Ниже приведены примеры ссылок с параметром lang.

Формат параметров строки запроса

Формат Base64

Отключение неиспользуемых языков

Отметим, что можно отключать неиспользуемые языки. В данном случае, страница оплаты будет доступна только на выбранных языках.

Меню (аватар) > Профиль компании

В разделе “Профиль компании” выберите вкладку “Языки”.

Изменение названия мерчанта

Параметр customMerchantName позволяет задать имя мерчанта, которое будет отображаться на странице оплаты вместо зарегистрированного. PulPal хранит данное название, что позволит различать оплаты, проведенные под разными названиями.

По всем техническим вопросам, обращаться: noc@pulpal.az

Готовое решение PulPal для оплаты на сайте

Система PulPal позволяет интегрировать возможности для оплаты в Ваше приложение. Для того, чтобы добавить кнопку на Вашу платформу, необходимо провести настройку мерчанта.

Тестовая и продуктовая среды

Система PulPal предоставляет тестовую среду для проверки интеграционных элементов. Параметры входа в тестовый аккаунт будут предоставлены посредством электронной почты; аккаунт для продуктовой среды будет создан во время заключения договора.

1 - Меню
2 - Merchant ID

Меню (аватар) > Профиль компании
В разделе “Профиль компании” выберите вкладку “Настройки”. Здесь необходимо указать следующие параметры:

Описание запросов

Зачем нужна подпись?

Замечание

Данная структура может быть передана в систему PulPal в одном из двух форматах.

Формат параметров строки запроса (QueryString)

{parameters} -- это поля структуры PaymentData переданные как параметры строки запроса.

* Оплата в валюте AZN, конвертация выставленного счета согласно курсу Центрального Банка Азербайджана.
** см. Раздел “Оплата” > “Такситные методы оплат”
*** см. Раздел “Изменение страницы оплаты” > “Изменение названия мерчанта

Зачем нужна подпись?

ВНИМАНИЕ!

Запрос не обязательно должен содержать все перечисленные параметры.
● В случае, если задано значение параметра productUniqueCode, значения всех остальных полей игнорируется.
● В случае, если значение этого параметра не задано, в системе PulPal происходит регистрация нового продукта согласно значениям других полей в данной структуре.
● Параметр externalId служит для идентификации оплачиваемого продукта в Вашей системе. Это означает, что в этом поле можно указать, например, ID заказа или любую другую информацию, которая позволит идентифицировать покупку в Вашей системе.
● Если в системе PulPal уже зарегистрирован продукт с указанным значением externalId, то происходит его обновление в соответствии с другими параметрами структуры.

[DEPRECATED] Формат Base64

PaymentData — это строка в формате Base64, которая получается сериализацией JSON-объекта структуры Продукт и к которой была применена операция encodeURI.

Структура Продукт

* см. Раздел “Оплата” > “Такситные методы оплат”
** см. Раздел “Изменение страницы оплаты” > “Изменение названия мерчанта”

Зачем нужна подпись?

ВНИМАНИЕ!

Структура paymentData не обязательно должна иметь все перечисленные поля.

● В случае, если задано значение поля productUniqueCode, значения всех остальных полей игнорируется.
● В случае, если значение этого поля не задано, в системе PulPal происходит регистрация нового продукта согласно значениям других полей в данной структуре.
● Поле externalId служит для идентификации оплачиваемого продукта в Вашей системе. Это означает, что в этом поле можно указать, например, ID заказа или любую другую информацию, которая позволит идентифицировать покупку в Вашей системе.
● Если в системе PulPal уже зарегистрирован продукт с указанным значением externalId, то происходит его обновление в соответствии с другими полями структуры.

Оплата

При нажатии на кнопку, пользователь увидит окно “Оплата”. В окне “Оплата” пользователь сможет либо оплатить продукт онлайн, либо получить данные для оплаты посредством терминальных сетей.

Замечание

Дополнительно в окне оплаты будет предоставлена возможности войти в систему или зарегистрироваться в ней (см. следующий скриншот).

Процесс оплаты состоит из следующих этапов:

1. Пользователь переходит в систему PulPal по ссылке, размещенной на вашем сервисе
   
2. Пользователь может произвести онлайн-оплату через сервис PulPal или же, получив уникальный код, произвести оплату посредством терминальных сетей
     a) После проведения онлайн-оплаты, пользователь будет перенаправлен на ссылку Redirect URL
   
3. После перенаправления на Redirect URL или оплаты посредством терминала, в системе PulPal начинается обработка платежа. После успешного завершения обработки, вызывается метод Delivery с вышеуказанными параметрами.

Такситные методы оплат

PulPal предоставляет возможность оплаты товаров с помощью такситных карт. Ниже приведена таблица допустимых значений параметра PROVIDER:

Kapital Bank BirKart

Bank of Baku BolKart

ABB TamKart

Yapi Bank WorldKart

Изменение страницы оплаты

Изменение языка страницы

По умолчанию, язык страницы оплаты определяется на основе настроек браузера. Однако, если возникает необходимость в отображении страницы оплаты на одном из трех поддерживаемых языков вне зависимости от настроек пользователя, то предлагается воспользоваться параметром lang, который принимает одно из трех значений: az, ru, en. Ниже приведены примеры ссылок с параметром lang

Формат параметров строки запроса

Формат Base64

Отключение неиспользуемых языков

Отметим, что можно отключать неиспользуемые языки. В данном случае, страница оплаты будет доступна только на выбранных языках.

Меню (аватар) > Профиль компании

В разделе “Профиль компании” выберите вкладку “Языки”.

Изменение названия мерчанта

Параметр customMerchantName позволяет задать имя мерчанта, которое будет отображаться на странице оплаты вместо зарегистрированного. PulPal хранит данное название, что позволит различать оплаты, проведенные под разными названиями.

По всем техническим вопросам, обращаться : noc@pulpal.az