Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Опис

Процес отримання звіту виконується в дві дії:

  1. Виконати запит для отримання токену для конкретного сервісу.

  2. Виконати запит по токену і отримати звіт у синхронній відповіді.


API параметри

Параметри для отримання токену

Warning

Токен валідний 60 хв.

Warning

Під кожен сервіс IA, C2A, A2C треба октримати отримати окремий токен.

HTTP METHOD: POST

API ENDPOINT: https://138.68.178.83/api/merchant/transactions/token

Параметр

Значення

Опис

Особливості

api_key

Status
colourGreen
titleОбов'язковий

String

API ключ

request_id

Status
colourGreen
titleОбов'язковий

String

Унікальний ідентифікатор запиту на боці мерчанта

limit

Status
colourGreen
titleОбов'язковий

Int

Кількість транзакцій в одному респонсі. За замовчуванням 100. Максимум 1000

date

Status
colourGreen
titleОбов'язковий

Date

Дата за яку сформувати звіт у форматі YYYY-MM-DD

service

Status
colourGreen
titleОбов'язковий

IA, C2A, A2C

Вказати один необхідний сервіс. Під кожен сервіс окремий токен

signature

Status
colourGreen
titleОбов'язковий

String

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

Code Block
languagephp
md5(
  strrev(api_key).
  strrev(request_id).
  strrev(api_secret)
)

Параметри для отримання даних по токену

HTTP METHOD: POST

API ENDPOINT: https://138.68.178.83/api/merchant/transactions/token_data

Параметр

Значення

Опис

Особливості

api_key

Status
colourGreen
titleОбов'язковий

String

API ключ

request_id

Status
colourGreen
titleОбов'язковий

String

Унікальний ідентифікатор запиту мерчанта

page

Status
colourGreen
titleОбов'язковий

String

Номер сторінки звіту

token

Status
colourGreen
titleОбов'язковий

String

Токен

Warning

Токен валідний 60 хв.

signature

Status
colourGreen
titleОбов'язковий

String

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

Code Block
languagephp
md5(
  strrev(api_key).
  strrev(request_id).
  strrev(api_secret)
)

Приклад коду

Expand
titleПриклад коду на PHP для отримання токену
Code Block
languagephp
<?php
$api_secret = 'pass_2';
$data['api_key'] = 'key_2';
$data['request_id']= 7897834;
$data['limit']= '100';
$data['date']= '2024-10-17';
$data['service']= 'IA';
$data['signature']= md5(
                        strrev($data['api_key']).
                        strrev($data['request_id']).
                        strrev($api_secret)
                      );

$url = 'https://138.68.178.83/api/merchant/transactions/token';

$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))
{
    return 'ERROR: ' . curl_error($crq);
}
else echo  $result;

curl_close($crq);
Expand
titleПриклад коду на PHP для отримання звіту
Code Block
languagephp
<?php
$api_secret = 'pass_2';
$data['api_key'] = 'key_2';
$data['request_id'] = 45657648;
$data['token'] = 'c1a9493d-477b-4fc4-b0cd-b66ee391100e';
$data['page'] = '1';
$data['signature'] = md5(
                        strrev($data['api_key']).
                        strrev($data['request_id']).
                        strrev($api_secret)
                      );

$url = 'https://138.68.178.83/api/merchant/transactions/token_data';

$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)) {
    return 'ERROR: ' . curl_error($crq);
} else echo $result;

curl_close($crq);

Response

Code Block
{
"request_id": ""
,
"status": "success",
" "
service "IA"
: ,
" "
pagination :
{
"page" "1"
: ,
"limit" "500"
: ,
"total_pages" "3"
: ,
"total_items" "1239"
: ,
"transactions":
[
{
"Order ID": "40697-61870-91704",
"Client order ID": ""
,
"MID": ""
,
"Status": "SUCCESS",
"Card": "414951******8499",
"Amount": "-5000,00",
"Commission": "0,00",
"Processing Date": "2024-02-04",
"Ret Sum": "-5000,00",
"Transaction Date": "2024-02-03 18:03:08",
"Description": ""
},
{
"Order ID": "40697-61870-91704",
"Client order ID": ""
,
"MID": ""
,
"Status": "SUCCESS",
"Card": "414951******8499",
"Amount": "-5000,00",
"Commission": "0,00",
"Processing Date": "2024-02-04",
"Ret Sum": "-5000,00",
"Transaction Date": "2024-02-03 18:03:08",
"Description": ""
},
{
"Order ID": "40697-61870-91704",
"Client order ID": ""
,
"MID": ""
,
"Status": "SUCCESS",
"Card": "414951******8499",
"Amount": "-5000,00",
"Commission": "0,00",
"Processing Date": "2024-02-04",
"Ret Sum": "-5000,00",
"Transaction Date": "2024-02-03 18:03:08",
"Description": ""
]
},
}

Помилки

Помилка

Опис

Incorrect signature

Помилка в підписі

Merchant not found

Невірно вказано API ключ

104: Token not found Токен

Токен більше не валідний або не існує

105: Page not exist

Вказаної сторінки не існує

106: In progress

Звіт ще не сформовано, спробуйте пізніше

107: Report failed

Звіт не в статусі Complete