NAV Navbar
CURL
  • Использование
  • Авторизация
  • Платежи
  • Уведомление партнера
  • Использование

    Данное API предназначено для взаимодейтсвия с платформой Kassa.com.

    Авторизация

    Авторизация с помощью заголовка

    curl https://kassa.com/api/v1/method \
       -H 'Autrorization: Bearer partner@mail.com:TOKEN'
    
    <?php
    
    // In development
    

    Авторизация с помощью базовой авторизации

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

    По умолчанию у партнера один ключ с максимальным набором привилегий.

    curl https://kassa.com/api/v1/method \
       -u 'partner@mail.com:TOKEN'
    
    <?php
    
    // In development
    

    Платежи

    Создание платежа

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

    {
       "order": {
          "currency": "RUB",
          "amount": 10.00,
          "description": "test"
       },
       "settings": {
          "project_id": 1,
          "payment_method": "card",
          "success_url": "http://site.com?success",
          "fail_url": "http://site.com?fail"
       },
       "custom_parameters":{
          "email": "vasia@gmail.com",
          "order_id": 515
       }
    }
    

    Чтобы принять оплату, необходимо создать объект платежа — Payment. Он содержит всю необходимую информацию для проведения оплаты (сумму, валюту и статус). У платежа линейный жизненный цикл, он последовательно переходит из статуса в статус.

    Атрибуты

    Параметр Обязательный Описание параметра
    order Да Данные заказа
    > amount Да Сумма платежа
    > currency Да Трехбуквенный код валюты платежа
    > description Нет Описание заказа
    settings Да Настройки
    > project_id Да Идентификатор проекта
    > payment_method Нет Метод оплаты
    > success_url Нет Урл возврата при успешном платеже
    > fail_url Нет Урл возврата при не успешном платеже
    custom_parameters Нет Пользовательские параметры (key:value)

    Ответ

    Формат ответа:

    {
        "token": "7-e1f07b1459-8e98eee519-56c3a80423",
        "payment_url": "https://pay.kassa.com/7-e1f07b1459-8e98eee519-56c3a80423"
    }
    
    Параметр Описание параметра
    token Уникальный ИД операции, защищенный от перебора. Используется для подтверждения платежа через API.
    payment_url Адрес редиректа на форму оплаты пользователя

    Проведение платежа

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

    {
        "payment": {
            "payment_method": "card",
            "token": "7-e1f07b1459-8e98eee519-56c3a80423",
            "ip_address": "127.0.0.1"
        },
        "auth_data": {
            "account": "79521045576",
            "card_number": "4200000000000000",
            "card_month": "03",
            "card_year": "19",
            "card_security": "123"
        }
    }
    

    Подтверждение платежа используется если партнер сам реализует логику отображения методов и форм оплаты на своей стороне, на нашу платформу передается токен операции, тип платежной системы и идентификатор пользователья в платежной системе (номер кошелька)

    Атрибуты

    Параметр Обязательный Описание параметра
    payment Да Данные платежа
    > payment_method Да Метод оплаты
    > token Да Уникальный ИД операции, защищенный от перебора.
    > ip_address Да IP адрес покупателя
    auth_data Да Данные для авторизации в ПС
    > account Да Номер счета в ПС
    > card_* Нет Данные пластиковой карты

    Ответ

    Формат ответа:

    {
        "payment": {
            "id": 12434,
            "amount": 10.00,
            "currency": "RUB",
            "token": "7-e1f07b1459-8e98eee519-56c3a80423",
            "create_date": "2017-10-01T10:55",
            "account": "48734xxxxxx4534",
            "ip": "127.0.0.1"
        },
        "authorization": {
            "action": "http://superbank.com/auth.php",
            "method": "POST",
            "params": {
                "PaReq": "Nkshkuehnkf7LsKNSFEPwqnf[98u23f",
                "MD": "123456"
            }
        }
    }
    
    Параметр Описание параметра
    payment Данные платежа
    authorization Данные для доп.авторизации клиента

    Уведомление партнера

    Данные для обработчика

    Уведомление сервера партнера о событиях c платежом (проведение платежа, ошибка платежа, возврат платежа)

    Пример данных на обработчик

    {
        "notification_type":"check",
        "payment": {
            "id": 12434,
            "amount": 10.00,
            "currency": "RUB",
            "token": "7-e1f07b1459-8e98eee519-56c3a80423",
            "create_date": "2017-10-01T10:55",
            "account": "48734xxxxxx4534",
            "ip": "127.0.0.1"
        }
    }
    

    Атрибуты

    Параметр Описание параметра
    notification_type Тип уведмоления
    payment Данные объекта нотификации

    Атрибут notification_type

    Параметр Описание параметра
    check начало проведения платежа (статус PROCESS, после вводы данных на форме)
    pay успешно списание (статус SUCCESS)
    error ошибка платежа (статус ERROR)
    refund возврат платежа (статус REFUND)

    Ответ

    Формат успешного ответа

    {
        "status": "ok"
    }
    

    Формат ошибочного ответа

    {
        "status": "error",
        "message": "Пользователь не существует"
    }
    
    Параметр Описание параметра
    status статус готовности магазина обработать платеж, ok или error
    message комментарий к ошибочному статусу (будет выведена на форму оплаты)