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

Пример

Запрос

URL

POSThttps://api-merchant.alikassa.io/v1/payment/status📋

Заголовки:

Content-Type: application/json
Account: UUID вашего аккаунта (доступен по адресу: Счета проекта)
Sign: Подпись запроса

Перейдите в Настройки API сертификатов и сгенерируйте «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('Ошибка сертификата.');
}

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

import { readFileSync } from 'fs';
import { createSign } from 'crypto';

const dataStr = JSON.stringify(data);
const privateKeyPem = readFileSync('private.pem', 'utf8');
const passphrase = readFileSync('password.txt', 'utf8').trim();
const signer = createSign('SHA1');
signer.update(dataStr);
signer.end();
const sign = signer.sign({ key: privateKeyPem, passphrase }, 'base64');

import json, base64
from cryptography.hazmat.primitives import hashes, serialization
from cryptography.hazmat.primitives.asymmetric import padding

data_bytes = json.dumps(data).encode('utf-8')
with open('password.txt','rb') as f:
    password = f.read().strip()
with open('private.pem','rb') as f:
    private_key = serialization.load_pem_private_key(f.read(), password=password)
signature = private_key.sign(data_bytes, padding.PKCS1v15(), hashes.SHA1())
sign = base64.b64encode(signature).decode('utf-8')

import java.nio.file.Files;
import java.nio.file.Paths;
import java.security.Signature;
import java.util.Base64;
import org.bouncycastle.openssl.PEMEncryptedKeyPair;
import org.bouncycastle.openssl.PEMParser;
import org.bouncycastle.openssl.jcajce.JcePEMDecryptorProviderBuilder;
import org.bouncycastle.openssl.jcajce.JcaPEMKeyConverter;

byte[] dataBytes = new ObjectMapper().writeValueAsBytes(data);
char[] pass = Files.readString(Paths.get("password.txt")).toCharArray();
PEMParser parser = new PEMParser(Files.newBufferedReader(Paths.get("private.pem")));
PEMEncryptedKeyPair ckp = (PEMEncryptedKeyPair) parser.readObject();
PrivateKey privateKey = new JcaPEMKeyConverter()
    .getKeyPair(ckp.decryptKeyPair(new JcePEMDecryptorProviderBuilder().build(pass)))
    .getPrivate();
Signature sig = Signature.getInstance("SHA1withRSA");
sig.initSign(privateKey);
sig.update(dataBytes);
String sign = Base64.getEncoder().encodeToString(sig.sign());

import (
    "crypto"
    "crypto/rand"
    "crypto/rsa"
    "crypto/sha1"
    "crypto/x509"
    "encoding/base64"
    "encoding/json"
    "encoding/pem"
    "io/ioutil"
)

dataBytes, _ := json.Marshal(data)
pemBytes, _ := ioutil.ReadFile("private.pem")
passBytes, _ := ioutil.ReadFile("password.txt")
block, _ := pem.Decode(pemBytes)
der, _ := x509.DecryptPEMBlock(block, passBytes)
priv, _ := x509.ParsePKCS1PrivateKey(der)
hash := sha1.Sum(dataBytes)
sigBytes, _ := rsa.SignPKCS1v15(rand.Reader, priv, crypto.SHA1, hash[:])
sign := base64.StdEncoding.EncodeToString(sigBytes)

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

Обязательные поля

Обязательный параметр

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

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

Ответ

Поле	Описание
`url`	Ссылка на оплату
`antiFraud`	Результат антифрод-проверки
`payment_status`	Статус платежа
`id`	ID платежа в AliKassa
`order_id`	Ваш ID заказа
`amount`	Запрошенная сумма
`payment_amount`	Фактически оплаченная сумма
`is_partial_payment`	Является ли частичной оплатой
`hold_amount`	Сумма на холде
`hold_at`	Дата/время освобождения холда
`account_payment_amount`	Сумма, зачисленная на аккаунт
`commission_amount`	Комиссия
`currency`	Код валюты (ISO 4217)
`service_code`	Код сервиса
`account_old_balance`	Баланс до транзакции
`account_new_balance`	Баланс после транзакции
`crypto_network`	Криптовалютная сеть (если применимо)
`crypto_txid`	Хэш/ID крипто-транзакции
`customer_phone`	Телефон клиента
`customer_card_number`	Номер карты клиента (маскированный)
`payment_error_message`	Сообщение об ошибке при неудачном платеже
`card_number`	Полный номер карты (если доступен)
`card_holder_name`	Имя владельца карты
`bank`	Название банка
`bik_bank`	БИК банка

Значения статуса платежа:

wait — в процессе оплаты
paid — успешно оплачено (финальный статус)
cancel — отменен (финальный статус)
fail — ошибка (финальный статус)

*Успешный ответ (HTTP CODE 200)*

{
  "url": "https://redirectlinkpay.com/293259c3-688b-33c1-a832-d77e1cd82f45",
  "antiFraud": false,
  "payment_status": "paid",
  "id": 112412553,
  "order_id": "1756900030",
  "amount": "10.000000000",
  "payment_amount": "10.000000000",
  "is_partial_payment": false,
  "hold_amount": "",
  "hold_at": null,
  "account_payment_amount": "9.000000000",
  "commission_amount": "1.000000000",
  "currency": "EUR",
  "service_code": "payment_card_eur_card",
  "account_old_balance": "16.00000000",
  "account_new_balance": "25.00000000",
  "crypto_network": null,
  "crypto_txid": null,
  "customer_phone": null,
  "customer_card_number": null,
  "payment_error_message": null,
  "card_number": null,
  "card_holder_name": null,
  "bank": null,
  "bik_bank": null
}

HTTP CODE 400 — Ошибка:

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

*Платёж с указанным ID/order_id не найден. Пожалуйста, обратитесь в службу поддержки и предоставьте логи запроса и ответа при создании платежа для выяснения причины.*

{
    "message": "Payment not found",
}

500 Server Error — Непредвиденная ошибка на стороне сервера.
Возникла внутренняя ошибка при обработке запроса. Статус платежа не может быть определён. При получении такой ошибки необходимо обратиться в поддержку, приложив логи запроса и ответа, чтобы уточнить причину и статус.

{
  "message": "Internal server error"
}

Уведомления

Настройка уведомлений

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

Пример кода

Распакуйте скачанный архив в папку cert/payment/ (относительно корня вашего скрипта)

<?php
$url = 'https://api-merchant.alikassa.io/v1/payment/status';
$data = ['order_id' => '123456'];

$payload = json_encode($data);

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

if ($privateKey === false) {
    throw new \Exception('Ошибка сертификата.');
}

openssl_sign($payload, $signature, $privateKey);
$sign = base64_encode($signature);

$headers = [
    'Content-Type: application/json',
    'Account: your-account-uuid',
    'Sign: ' . $sign,
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

import { readFileSync } from 'fs';
import { createSign } from 'crypto';
import https from 'https';

async function requestPayment(method, account, data) {
  const dataStr = JSON.stringify(data);
  const privateKeyPem = readFileSync('cert/payment/private.pem', 'utf8');
  const passphrase = readFileSync('cert/payment/password.txt', 'utf8').trim();
  const signer = createSign('SHA1');
  signer.update(dataStr);
  signer.end();
  const sign = signer.sign({ key: privateKeyPem, passphrase }, 'base64');

  const options = {
    hostname: 'api-merchant.alikassa.io',
    path: `/${method}`,
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Account: account,
      Sign: sign,
      'User-Agent': 'AliKassa2.0 API',
    },
    timeout: 30000,
  };

  return new Promise((resolve, reject) => {
    const req = https.request(options, (res) => {
      let body = '';
      res.on('data', (chunk) => (body += chunk));
      res.on('end', () => resolve(JSON.parse(body)));
    });
    req.on('error', reject);
    req.write(dataStr);
    req.end();
  });
}

(async () => {
  const payment = await requestPayment(
    'v1/payment/status',
    '93d5df06-996c-48c3-9847-348d6b580b80',
    {
      id: '100000536',
    }
  );
  console.log(payment);
})();

import json
import base64
from cryptography.hazmat.primitives import hashes, serialization
from cryptography.hazmat.primitives.asymmetric import padding
import requests

def request_payment(method: str, account: str, data: dict):
    data_bytes = json.dumps(data).encode('utf-8')
    with open('cert/payment/password.txt', 'rb') as f:
        password = f.read().strip()
    with open('cert/payment/private.pem', 'rb') as f:
        private_key = serialization.load_pem_private_key(f.read(), password=password)
    signature = private_key.sign(data_bytes, padding.PKCS1v15(), hashes.SHA1())
    sign = base64.b64encode(signature).decode('utf-8')
    headers = {
        'Content-Type': 'application/json',
        'Account': account,
        'Sign': sign,
        'User-Agent': 'AliKassa2.0 API',
    }
    resp = requests.post(f'https://api-merchant.alikassa.io/{method}', data=data_bytes, headers=headers, timeout=30)
    return resp.json()

payment = request_payment('v1/payment/status', '93d5df06-996c-48c3-9847-348d6b580b80', {
    'id': '100000536',
})
print(payment)

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.security.Signature;
import java.util.Base64;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.bouncycastle.openssl.PEMEncryptedKeyPair;
import org.bouncycastle.openssl.PEMParser;
import org.bouncycastle.openssl.jcajce.JcePEMDecryptorProviderBuilder;
import org.bouncycastle.openssl.jcajce.JcaPEMKeyConverter;
import java.io.FileReader;

public class Example {
    public static void main(String[] args) throws Exception {
        ObjectMapper mapper = new ObjectMapper();
        var data = Map.of("id", "100000536");
        String dataStr = mapper.writeValueAsString(data);
        char[] pass = Files.readString(Paths.get("cert/payment/password.txt")).toCharArray();
        PEMParser parser = new PEMParser(new FileReader("cert/payment/private.pem"));
        PEMEncryptedKeyPair ckp = (PEMEncryptedKeyPair) parser.readObject();
        var kp = new JcaPEMKeyConverter().getKeyPair(
            ckp.decryptKeyPair(new JcePEMDecryptorProviderBuilder().build(pass))
        );
        Signature sig = Signature.getInstance("SHA1withRSA");
        sig.initSign(kp.getPrivate());
        sig.update(dataStr.getBytes(StandardCharsets.UTF_8));
        String sign = Base64.getEncoder().encodeToString(sig.sign());
        HttpRequest request = HttpRequest.newBuilder()
            .uri(java.net.URI.create("https://api-merchant.alikassa.io/v1/payment/status"))
            .header("Content-Type", "application/json")
            .header("Account", "93d5df06-996c-48c3-9847-348d6b580b80")
            .header("Sign", sign)
            .header("User-Agent", "AliKassa2.0 API")
            .POST(HttpRequest.BodyPublishers.ofString(dataStr))
            .build();
        var client = HttpClient.newHttpClient();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(mapper.readValue(response.body(), Object.class));
    }
}

package main

import (
    "bytes"
    "crypto"
    "crypto/rand"
    "crypto/rsa"
    "crypto/sha1"
    "crypto/x509"
    "encoding/base64"
    "encoding/json"
    "encoding/pem"
    "io/ioutil"
    "net/http"
    "time"
)

func signData(data interface{}) string {
    dataBytes, _ := json.Marshal(data)
    pemBytes, _ := ioutil.ReadFile("cert/payment/private.pem")
    passBytes, _ := ioutil.ReadFile("cert/payment/password.txt")
    block, _ := pem.Decode(pemBytes)
    der, _ := x509.DecryptPEMBlock(block, passBytes)
    priv, _ := x509.ParsePKCS1PrivateKey(der)
    hash := sha1.Sum(dataBytes)
    sigBytes, _ := rsa.SignPKCS1v15(rand.Reader, priv, crypto.SHA1, hash[:])
    return base64.StdEncoding.EncodeToString(sigBytes)
}

func requestPayment(method, account string, data interface{}) (map[string]interface{}, error) {
    sign := signData(data)
    dataBytes, _ := json.Marshal(data)
    req, _ := http.NewRequest("POST", "https://api-merchant.alikassa.io/"+method, bytes.NewReader(dataBytes))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Account", account)
    req.Header.Set("Sign", sign)
    req.Header.Set("User-Agent", "AliKassa2.0 API")
    client := &http.Client{Timeout: 30 * time.Second}
    resp, _ := client.Do(req)
    defer resp.Body.Close()
    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)
    return result, nil
}

func main() {
    payment, _ := requestPayment("v1/payment/status", "93d5df06-996c-48c3-9847-348d6b580b80", map[string]interface{}{
        "id": "100000536",
    })
    fmt.Println(payment)
}

Пример​

Запрос​

Обязательные поля​

Ответ​

Уведомления​

Пример кода​