Проверка статуса выплаты

Проверка статуса выплаты

URL POST
https://api-merchant.alikassa.com/v1/payout/status
HEADER
Content-Type application/json
Account Ваш uuid счета (вы можете найти в разделе "Счета")
https://merchant.alikassa.com/cabinet/resources/project-accounts
Sign Подпись запроса

По ссылке https://merchant.alikassa.com/cabinet/form/setting-api-certs сгенерируйте «API сертификат на выплаты», сохраните архив, распакуйте

  • password.txt
  • private.pem
  • public.pem

Мы сохраняем у себя только public.pem для проверки подписи.

Оберните все POST данные в json(в том же порядке) и подпишите

$data = json_encode($data);

$privateKey = openssl_pkey_get_private(
        file_get_contents('private.pem'),
        file_get_contents('password.txt')
    );

if ($privateKey===false) {

        throw new \Exception('Error cert.');
}

openssl_sign($data, $sign, $privateKey);
$sign = base64_encode($sign);

Полученную подпись $sign передайте в заголовке "Sign". Пример кода найдете в конце документа.

Название Тип Описание
order_id string (128) Ваш id указанный при создании
id string (128) Id платежа AliKassa

Вы должны передать order_id или id.

Ответ

Название Описание
order_id Ваш id указанный при создании
id Id платежа AliKassa
payment_status Статус платежа
wait — в процессе оплаты
paid — успешно оплачено (финальный статус)
cancel — отменен (финальный статус)
fail — ошибка (финальный статус)
card_mask Маска карты при оплате картой
amount Сумма
payment_amount Выплаченная сумма
is_partial_payment Является ли выплата частичной
account_payment_amount Сумма зачисление на счет
commission_amount Комиссия
service_code Сервис
RRN RRN
account_old_balance Баланс до создания запроса
account_new_balance Баланс после обработки запроса

Пример успешного ответа HTTP CODE 200:

{
   "payment_status": "paid",
   "id": 100000536,
   "order_id": "6422494",
   "amount": "300.00",
   "payment_amount": "300.00",
   "is_partial_payment": false,
   "account_payment_amount": "290",
   "commission_amount": "10",
   "service_code": "payment_card_rub",
   "rrn": "11111111111",
   "account_old_balance": "1290",
   "account_new_balance": "1000"
}

Пример не успешного ответа HTTP CODE 400:

{
   "message": "The given data was invalid.",
   "errors": {
      ...
   }
}

Если вы передали notification_endpoint_id, то вы получите уведомление о смене статуса выплаты.

Пример

Скачанный архив распакуйте в папку «путь до скрипта/cert/payout/»

function requestPayment(string $method, string $account, array $data)
{
    $data = json_encode($data);

    $privateKey = openssl_pkey_get_private(
        file_get_contents(__DIR__ . '/cert/payout/private.pem'),
        file_get_contents(__DIR__ . '/cert/payout/password.txt')
    );

    if ($privateKey===false) {

        throw new \Exception('Error cert.');
    }

    openssl_sign($data, $sign, $privateKey);
    $sign = base64_encode($sign);

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, 'https://api-merchant.alikassa.com/' . $method);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Content-Type: application/json',
        'Account: ' . $account,
        'Sign: ' . $sign,
    ]);
    curl_setopt($ch, CURLOPT_HEADER, 0);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($ch,CURLOPT_USERAGENT, 'AliKassa2.0 API');
    curl_setopt($ch, CURLOPT_TIMEOUT, 30);

    $response = curl_exec($ch);

    return json_decode($response, true);
}


$payout = requestPayment('v1/payout/status', '93d5df06-996c-48c3-9847-348d6b580b80', [
    'id' => '100000536',
]);

var_dump($payout);