Info
Этот функционал будет активирован после вашего запроса в групповом чате. Также обязательно сообщите IP адреса, с которых будут отправляться запросы для добавления в белый список.

Note
Ваш сайт должен работать по схеме HTTPS и поддерживать протокол TLS 1.2.

Table of Contents

Описание

Регулярный платеж позволяет проводить списание без участия плательщика.

В запросе используется ранее сохраненная карта в виде зашифрованого CARD_TOKEN, который можно получить из callback при первой Оплата картой или Верификации карты.

Дополнительно рекомендуем ознакомиться с разделом Особенности токенов

Требования

Уведомить клиентов об условиях подписки и регулярных списаниях
Получить согласие клиентов на регулярные списания
Получить согласие клиентов с условиями договора публичной оферты
Рекомендуем дать возможность отмены подписки клиентом на сайте или приложении
Согласно правил МПС разрешается 1 попытка списания в день
Разместить договор публичной оферты
Разместить логотипы платежных систем Visa и Mastercard
Добавить логотипы PSP Platon

API параметры запроса

HTTP METHOD: StatuscolourGreentitle

Info
Цей функціонал буде активовано після вашого запиту в груповому чаті.

Зміст

Table of Contents

minLevel	1
maxLevel	2
include
outline	false
indent	0px
style	circle
exclude
type	list
class
printable	false

Опис

Регулярний платіж дозволяє робити списання коштів без участі платника.

В запиті використовується раніше збережена картка у вигляді зашифрованого CARD_TOKEN, який можна отримати при першій транзакції по картці.

Вимоги

Include Page

	Вимоги до сайтів та додатків
	Вимоги до сайтів та додатків

API параметри

HTTP METHOD: POST

API ENDPOINT: https://secure.platononline.com/post-unq/

Параметр

Значение

Значення

Описание

Опис

Особенности

Обязательно

Особливості
`action`

SALE

Код платежного метода

Только одно значение

Status

title
colour	Green

да

обов'язковий

async

SALE

Y
N

Включить асинхронный режим

В асинхронном режиме обязательное использование коллбеков.
По умолчанию значение N

Status

colour	Yellow
title	нет

channel_id

String

Дополнительный платежный канал

Позволяет отправить платежи на другой банковский терминал

Код платіжного метода

client_key

Status

colour

Yellow

title
Green

нет

client_key

обов'язковий

String

API ключ мерчанта

Ключ

предоставляется

надається на

почту

пошту мерчанту

order_id

Status

title
colour	Green

да

order_id

обов'язковий

String

ID

платежа

оплати в

системе

системі мерчанта

Max 32

символа

символи

order_amount

Status

title
colour	Green

да

order_amount

обов'язковий

Number

Сумма платежа

Сума оплати

Tip

Верный вариант

Вірний варіант

1000.00

Warning

Неверные варианты

Невалідні варіанти

1000
1000.0
1,000.0
1,000.00

order_currency

Status

title
colour	Green

да

order_currency

обов'язковий

UAH

Валюта

платежа

Info
Оплата

возможна только в национальной валюте гривнеorder_description

можлива лише в національній валюті гривні

order_description

Status

title
colour	Green

да

обов'язковий

String

Описание платежа

Опис

Max 255

символов

символів

card_token

Status

title
colour	Green

да

card_token

обов'язковий

String

Токен

карты

картки

card_token

из коллбека первичной транзакции

з callback першої оплати

payer_email

Status

title
colour	Green

да

payer_first_name

String

Имя плательщика

Max 32 символа без пробелов

обов'язковий

String

Пошта платника

Info
Валідна пошта

Info
Без пробілів

payer_ip

Status

colour

Yellow

title
Green

нет

payer_last_name

String

Фамилия плательщика

Max 32 символа без пробелов

	обов'язковий

Number

IP-адрес платника

В форматі "ХХХ.ХХХ.ХХХ.ХХХ"

Note
IPv6 не підтримується

term_url_3ds

Status

colour	Green
title	обов'язковий

String

Посилання куди перейде платник після проби оплати (успішної чи невдалої)

ext3

Status

colour

Yellow

title
Green

нет

payer_address

String

Адрес плательщика

Max 256 символа

обов'язковий

recurring

Ознака регулярної оплати

hash

Status

colour

Yellow

title
Green

нет

payer_country

String

Страна плательщика

В формате "ХХ"
2 символа
Укажите NA, если нет данныхВ формате "ХХ"
2 символа
Укажите NA, если нет данных

обов'язковий

String

Контрольний підпис

Code Block

language	php

md5(
  strtoupper(
    strrev($payer_email).
    $client_pass.
    strrev($card_token)
  )
)

Info
Если при первоначальном запросе на оплату не был указан `email`, то следует указать пустое значение для `email`.

async

Status

title
colour	Yellow

нет

payer_state

String

Штат плательщика

Max 32 символа
Укажите NA, если нет данных

не обов'язковий

Y
N

Включити асинхронний режим

В асинхронному режимі обов'язкове використання коллбеків.
Стандартне значення N

channel_id

Status

title
colour	Yellow

нет

payer_city

String

Город плательщика

не обов'язковий

String

Додатковий платіжний канал

Дозволяє відправити оплати на інший банківський термінал

payer_first_name

Status

title
colour	Yellow

нет

payer_zip

String

Почтовый индекс плательщика

не обов'язковий

String

Ім'я платника

Max 32

символа
Укажите NA, если нет данных

символи без пробілів

payer_last_name

Status

title
colour	Yellow

нет

payer_email

String

Почта плательщика

Info

Указать значение из первоначального запроса на оплату, когда был получен токен.

Оставить пустое значение, если параметр был без значения.

не обов'язковий

String

Прізвище платника

Max 32 символи без пробілів

payer_address

Status

title
colour	Yellow

нет

payer_phone

Number

Номер телефона плательщика

В формате “380XXXXXXXXX”
Max 32 символа

не обов'язковий

String

Адреса платника

Max 256 символів

payer_country

Status

title
colour	Yellow

нет

payer_ip

Number

IP-адрес плательщика

В формате "ХХХ.ХХХ.ХХХ.ХХХ"

не обов'язковий

String

Країна платника

В форматі "ХХ"
Max 2 символи
Вкажіть NA, якщо немає даних

payer_state

Status

colour

Greencustomer_wallet

title
Yellow

да

term_url_3ds

String

https://platon.ua

не обов'язковий

String

Номер електронного кошелька пользователя

Поле обязательно для типов бизнеса связаных с виртуальными активами

Status

colour	Yellow
title	нет

Штат платника

В форматі "ХХ"
Max 2 символи
Вкажіть NA, якщо немає даних

payer_city

Status

colour

Green

title
Yellow

да

auth

Y
N

Холдирование средств на карте плательщика

Y или N (по умолчанию N)

не обов'язковий

String

Місто платника

Max 32 символи
Вкажіть NA, якщо немає даних

payer_zip

Status

title
colour	Yellow

нет

ext3

recurring

Признак регулярного платежа

не обов'язковий

String

Поштовий індекс платника

Max 32 символи
Вкажіть NA, якщо немає даних

payer_phone

Status

colour

Green

title
Yellow

да

hash

String

Контрольная подпись

Code Block

language	php

md5(
  strtoupper(
    strrev($payer_email).
    $client_pass.
    strrev($card_token)
  )
)

InfoЕсли при первоначальном запросе на оплату не был указан email, то следует указать пустое значение для email.

не обов'язковий

Number

Номер телефону платника

В форматі “380XXXXXXXXX”
Max 32 символів

customer_wallet

Status

colour

Green

title
Yellow

да

Примеры запроса

Для просмотра примера раскройте список

	не обов'язковий

String

Номер електронного гаманця платника

Поле обов'язкове для типів бізнесу пов'язаних з віртуальними активами

Приклад запиту

Expand

title	Пример запроса Приклад запиту на PHP

Code Block

language	php

<?php
  $client_pass='***';
  $data['action']='SALE';
  $data['client_key']='***';
  $data['order_id']='458-3453';
  $data['order_amount']='1000.00';
  $data['order_currency']='UAH';
  $data['order_description']='test';
  $card$data['card_token'] = '*****';
  $data['payer_first_name']='Ivan';
  $data['payer_last_name']='Ivanov';
  $data['payer_phone']='+380111111111';
  $data['payer_email']='sale@gmail.com';
  $data['payer_ip']='213.186.115.164';
  $data['term_url_3ds']='http://google.com';
  $data['ext3hash']='recurring';   $hash = md5(
            strtoupper(
              strrev($data['payer_email']).
              $client_pass.
              strrev($card$data['card_token'])
            )
          );
?>

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>sale</title>
  </head>
  <body onload="javascript:document.forms[0].submit()">
    <form action="
$url = 'https://secure.platononline.com/post-unq/" method="post">
      <input type="hidden" name="action" value="<?=$data['action']?>" />
      <input type="hidden" name="client_key" value="<?=$data['client_key']?>" />
      <input type="hidden" name="order_id" value="<?=$data['order_id']?>" />
      <input type="hidden" name="order_amount" value="<?=$data['order_amount']?>" />
      <input type="hidden" name="order_currency" value="<?=$data['order_currency']?>" />
      <input type="hidden" name="order_description" value="<?=$data['order_description']?>" />
      <input type="hidden" name="card_token" value="<?=$card_token ?>" />
      <input type="hidden" name="payer_first_name" value="<?=$data['payer_first_name']?>" />
      <input type="hidden" name="payer_last_name" value="<?=$data['payer_last_name']?>" />
      <input type="hidden" name="payer_phone" value="<?=$data['payer_phone']?>" />
      <input type="hidden" name="payer_email" value="<?=$data['payer_email']?>" />
      <input type="hidden" name="payer_ip" value="<?=$data['payer_ip']?>" />
      <input type="hidden" name="term_url_3ds" value="<?=$data['term_url_3ds']?>" />
      <input type="hidden" name="ext3" value="<?=$data['ext3']?>" />
      <input type="hidden" name="hash" value="<?=$hash?>" />
    </form>                                            
  </body>
</html>

Iframe

scrolling	no
src	https://devplaton.com.ua/invoices/postman-test.html
frameborder	hide
style	height: 260px;

Тестирование

В целях тестирования используйте CARD_TOKEN полученный из коллбека при успешной транзакции с использованием наших тестовых реквизитов:

Проверка платежей

Получить информацию о платежах можно несколькими способами:

Используя Callback для автоматизации процесса зачисления в системе на вашей стороне
Нотификация в Telegram Bot об успешной оплате с деталями платежа сразу после списания
В вашем личном кабинете Platon
CSV файл с деталями платежей скачав в личном кабинете Platon
/wiki/spaces/docs/pages/2034926256
Банковский реестр на почту или ваш FTP
Дополнительная проверка статуса и деталей платежа по API

Работа с Callback

Info

Рекомендуем ознакомиться с разделами:

Callback и Response (Асинхронный режим)

Для просмотра примера раскройте список

Expand

title	Response о принятии запроса в обработку

Code Block

language	json

{
  "action":"SALE",
  "result":"ACCEPTED",
  "order_id":"4385302",
  "trans_id":"28261-34099-19648",
  "trans_date":"2020-02-25 06:50:09"
}

Параметр

Описание

action

SALE

result

ACCEPTED

order_id

Уникальный ордер ID транзакции в системе мерчанта

trans_id

Уникальный ордер ID транзакции в системе Platon

trans_date

Время проведения транзакции в формате UTC (YYYY-MM-DD HH-MM-SS)

Expand

title	Callback при успешном списании

Code Block

language	php

array (
  'action' => 'SALE',
  'result' => 'SUCCESS',
  'status' => 'SETTLED',
  'order_id' => '4385323',
  'trans_id' => '28261-47789-28578',
  'trans_date' => '2020-02-25 07:12:58',
  'descriptor' => NULL,
  'recurring_token' => '01e00c2b39bb3b933723307c442efd02',
  'card_token' => '8ef3111ac1093f6ccb817acef7f0845601d0994689a5f57949f94b0d086c7fe2',
  'hash' => '********************************',
)

Info

Для проверки достоверности полученного callback, рекомендуем сверять подпись hash по формуле md5(strtoupper(strrev(email).client_pass.trans_id.strrev(substr(card,0,6).substr(card,-4)))).

Внимание! Если при первоначальном запросе на оплату, когда был получен токен не был указан email, то при проверке sing в подписи коллбека следует указать пустое значение для email.

Параметр

Описание

action

SALE

result

SUCCESS

status

SETTLED (PENDING, если в запросе было указано auth = Y)

order_id

Уникальный ордер ID транзакции в системе мерчанта

trans_id

Уникальный ордер ID транзакции в системе Platon

trans_date

Время проведения транзакции в формате UTC (YYYY-MM-DD HH-MM-SS)

descriptor

NULL

recurring_token

Зашифрованный токен карты для последующих транзакций по rc_token

card_token

Зашифрованный токен карты для последующих транзакций по card_token

hash

Зашифрованная подпись для проверки достоверности коллбека

Expand

title	Callback при неуспешном списании

Code Block

language	php

array (
  'action' => 'SALE',
  'result' => 'DECLINED',
  'status' => 'DECLINED',
  'order_id' => '4092002',
  'trans_id' => '28076-29879-99538',
  'trans_date' => '2020-02-03 20:49:47',
  'decline_reason' => 'Declined by processing',
  'hash' => '********************************',
)

Info

Для проверки достоверности полученного callback, рекомендуем сверять подпись hash по формуле md5(strtoupper(strrev(email).client_pass.trans_id.strrev(substr(card,0,6).substr(card,-4)))).

Внимание! Если при первоначальном запросе на оплату, когда был получен токен не был указан email, то при проверке sing в подписи коллбека следует указать пустое значение для email.

Параметр

Описание

action

SALE

result

DECLINED

status

DECLINED

order_id

Уникальный ордер ID транзакции в системе мерчанта

trans_id

Уникальный ордер ID транзакции в системе Platon

trans_date

Время проведения транзакции в формате UTC (YYYY-MM-DD HH-MM-SS)

descriptor

NULL

decline_reason

Причина отмены транзакции

hash

Зашифрованная подпись для проверки достоверности коллбека

Просроченные токены

Note

Если в ответе на запрос вы получили одну из указанных ниже ошибок вам необходимо удалить токен как просроченный.

Invalid card_exp_month, card_exp_year
Invalid card_exp_month
Initial transaction too old

Warning
Данный CARD_TOKEN заблокированы и не подлежат восстановлению по причине блокировки / окончания действия банковской карты.

Tip
Необходимо получить новый CARD_TOKEN проведя верификацию или оплату.

Ошибки запросов

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

Для просмотра примера раскройте список

Response:

Expand

title	Список ошибок и их решение

Ошибка

Причины

Решение

Response: {"result":"ERROR","error_message":"Account error"}

Ваш IP адрес не добавлен в наш белый список.

Обратитесь в тех поддержку для добавления вашего IP в белый список.

Данный функционал вам не подключен.

Обратитесь в тех поддержку для активации функционала.

Запрос отправлен не на нужную ссылку.

Рекомендуем сверить ссылку для отправки запроса с указаной в нужном разделе документации.

';
$crq = curl_init();
curl_setopt($crq, CURLOPT_URL, $url);
curl_setopt($crq, CURLOPT_HEADER, 0);
curl_setopt($crq, CURLOPT_POST, 1);
curl_setopt($crq, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($crq, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($crq, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($crq, CURLOPT_POSTFIELDS, http_build_query($data));
$result = curl_exec($crq);
  if (curl_errno($crq)) {
    echo 'ERROR: '.curl_error($crq);
  }else{
    echo $result;
  }
curl_close($crq);

Info
Postman Collection

Тестування

В цілях тестування використовуйте card_token отриманий з коллбека успішної транзакції по одному з вказаних методів:

IE оплата карткою
Верифікація картки
C2A оплата
Виплата на картку по повному номеру картки

Перевірка платежів

Expand

title	Список методів отримання результату транзакцій

Include Page

	Отримання результату транзакції
	Отримання результату транзакції

Callback

Expand

title	Особливості роботи з Callback

Include Page

	Робота з Callback
	Робота з Callback

Expand

title	Безпека

Include Page

	Безпека
	Безпека

Синхронний режим

Стандартний режим. Передавати async = N не потрібно.

Асинхронний режим

Цей режим активується при передачі async = Y. В цьому режимі обов'язково необхідно використовувати callback.

Include Page

	Callback / Response - SALE без 3DS
	Callback / Response - SALE без 3DS

Протерміновані токени

Response:

Invalid card_exp_month, card_exp_year"}
{"result":"ERROR","error_message":"

Order already exists"}Response:

Invalid card_exp_month"}
{"result":"ERROR","error_message":"

Duplicate request

Initial transaction too old"}

Рекомендуем обратиться в тех саппорт Platon для проверки причины.

Note
Якщо у відповіді на запит ви отримали одну з вказаних нижче помилок, вам необхідно видалити цей протермінований токен: `{"result":"ERROR","error_message":"` Card token not found for current client"}	Отправка запроса по CARD_TOKEN отключена для данного API ключа так как CARD_TOKEN был получен на другом ключе.	Обратитесь в тех поддержку для решения данной ситуации.
`Response: {"result":"ERROR","error_message":"Incorrect hash"}`	Неверно сформирована зашифрованная подпись.	Проверьте верность сформированной подписи. Если ошибку не нашли обратитесь в тех поддержку.
	Добавлены параметры, которые не входят в данный запрос.	Проверьте список передаваемых параметров. Если ошибку не нашли обратитесь в тех поддержку.
	Запрос был отправлен не с того API ключа по которому был получен RC_TOKEN	Рекомендуем заменить API ключ на тот, по которому был получен RC_TOKEN
`Response: {"result":"ERROR","error_message":"Empty action"}`	Параметр `action` заполнен не верно, пуст, или не на первом месте в списке параметров запроса.	Проверьте список передаваемых параметров. Если ошибку не нашли обратитесь в тех поддержку.
Значение `order_id` должно быть уникальным. Данная ошибка говорит о том, что у вас уже был использован такой `order_id`.	Заменить значение `order_id` на новое уникальное.
`Response: {"result":"ERROR","error_message":"Recurring not supported"}`	Токен больше не активен по причине завершения срока действия карты, блокировки карты, или блокировки токена.	Рекомендуем плательщику провести провести повторную оплату/верификацию для получения нового токена. Токен по которому была получена данная ошибка необходимо удалить из вашей базы данных, использовать его для списаний больше невозможно по причине блокировки.
За одну минуту в систему вами было отправлено несколько одинаковых запросов.	Рекомендуем проверить ваш механизм отправки запросов на наличие задвоения.
`Response: {"result":"ERROR","error_message":"Incorrect card_token value"}`	Запрос был отправлен менее чем через 10 минут после получения токена.	Рекомендуем настроить отправку запросов минимум через 10 минут после получения токена. Запрос по которому получена эта ошибка необходимо повторить.
	В параметр `card_token` внесено неверное значение.	Рекомендуем проверить верность внесенных данных в поле `card_token` полученного из коллбека ранее. Запрос по которому получена эта ошибка необходимо повторить.
`Response: {"result":"ERROR","error_message":"Not found card token"}`	Запрос был отправлен менее чем через 10 минут после получения токена.	Рекомендуем настроить отправку запросов минимум через 10 минут после получения токена. Запрос по которому получена эта ошибка необходимо повторить.
	В параметр `card_token` внесено неверное значение.	Рекомендуем проверить верность внесенных данных в поле `card_token` полученного из коллбека ранее. Запрос по которому получена эта ошибка необходимо повторить.
`Response: {"result":"ERROR","error_message":"Service error"}`	Ситуация требует внимания сотрудников Platon.	Рекомендуем обратиться в тех саппорт Platon для проверки причины.
`Response: {"result":"ERROR","error_message":"Previous transaction not completed"}`	Ситуация требует внимания сотрудников Platon.

Warning
Ці `card_token` заблоковані та не підлягають відновленню по причині блокування / закінчення терміну дії картки.

Tip
Необхідно отримати новий `card_token` провівши нову оплату чи верифікацію.

Помилки запитів

Expand

title	Список помилок та рішень

Include Page

	Помилки та рішення при запитах
	Помилки та рішення при запитах

Versions Compared

Old Version 68

New Version Current

Key

Описание

Требования

API параметры запроса

Зміст

Опис

Вимоги

API параметри

Примеры запроса

Приклад запиту

Тестирование

Проверка платежей

Работа с Callback

Callback и Response (Асинхронный режим)

Просроченные токены

Ошибки запросов

Тестування

Перевірка платежів

Callback

Синхронний режим

Асинхронний режим

Протерміновані токени

Помилки запитів

Page Comparison

Versions Compared

Old Version 68

New Version Current

Key

Описание

Требования

API параметры запроса

Зміст

Опис

Вимоги

API параметри

Примеры запроса

Приклад запиту

Тестирование

Проверка платежей

Работа с Callback

Callback и Response (Асинхронный режим)

Просроченные токены

Ошибки запросов

Тестування

Перевірка платежів

Callback

Синхронний режим

Асинхронний режим

Протерміновані токени

Помилки запитів