Skip to main content

API для поставщика (reverse/refund . . .)

URL шлюза оплаты

https://paysys.uz/gateway

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

Получение информации о платежа​

Название метода: paysys.payment_info
Авторизация: требуется

API предоставляет информацию о транзакция, позволяя поставщика получать такие сведения, как дата, сумма, валюта и статус.

Запрос содержит:

  • transaction_id - идентификатор платежа в система PaySys
Пример запроса
{
  "method": "paysys.payment_info",
  "params": {
    "transaction_id": 11422530
  },
  "id": "a11c0276-d443-4675-a79a-2d829ee5286e"
}

Ответ содержит:

  • id - Идентификатор транзакции в системе PaySys.
  • vendor_user_id - Идентификатор заказа в система поставщика.
  • bank_transaction_id - Номер транзакции в системе PaySys.
  • amount - Сумма платежа.
  • currency - Валюта платежа.
  • status - Статус транзакции.
  • date - Время платежа.
  • mx_id - Трекер запроса.
Details
{
    "id": "a11c0276-d443-4675-a79a-2d829ee5286e",
    "error": null,
    "result": {
        "transaction_id": 11424156,
        "vendor_user_id": "1683530160817",
        "bank_transaction_id": 137664440,
        "amount": 1000,
        "currency": 860,
        "status": 2,
        "date": 1683530177
    },
    "mx_id": "588ffd16badd82e896f364935350f413"
}

В случае некорректных параметров запроса система вернет ошибку.

Отмена платежа​

Название метода: paysys.payment_cancel
Авторизация: требуется

Отмена (reversal, adjustements) платежа возможна в течении 7 дней, единожды, с момента операции (желательно до «закрытия бизнес дня»). Схема работы отмены: во время оплаты сумма по платежу блокируется (блок с минусом) для карты и становится недоступной для клиента (ждет клиринга, чтобы списать средства окончательно). Если поставщик услуг отменил платеж (reversal), то на карте появляется блокировка с плюсом, которая аннулирует первую блокировку (блок с минусом). Ранее заблокированная сумма на карте становиться доступной. Если клиент не видит блокировку с плюсом и средства по-прежнему не доступны, то нужно обратиться в банк-эмитент, который выпустил эту карту и запросить причину, по которой платеж не был отменен.

Запрос содержит:

  • transaction_id - Идентификатор платежа в система PaySys
Пример запроса
{
  "method": "paysys.payment_cancel",
  "params": {
    "transaction_id": 11422530
  },
  "id": "b17ab4a5-93e6-481a-bb90-ae7aa876afd1"
}

Ответ содержит:

  • transaction_id - Идентификатор транзакции в системе PaySys.
  • bank_transaction_id - Номер транзакции в системе PaySys.
  • vendor_user_id - Идентификатор заказа в система поставщика.
  • status - Статус транзакции.
Details
{
    "id": "b17ab4a5-93e6-481a-bb90-ae7aa876afd1",
    "error": null,
    "result": {
        "transaction_id": 11424156,
        "bank_transaction_id": 137664440,
        "vendor_user_id": "1683530160817",
        "status": 3
    },
    "mx_id": "588ffd16badd82e896f364935350f413"
}

В случае некорректных параметров запроса система вернет ошибку.

Возврат средства​

Название метода: paysys.payment_adjustments
Авторизация: требуется

Возврат средств (refund) по платежу возможен, с момента операции (желательно после «закрытия бизнес дня»). Можно проводить любое число возвратов при условии, что сумма всех возвратов меньше либо равна сумме исходного платежа, с учетом удерживаемой комиссии. При вовзратах комиссия эквайера не возвращается. Схема работы метода возврата: после инициализации операции возврата платежа (refund) поставщиком услуг, сумма приходит на карту клиента вместе с клирингом. Этот процесс обычно занимает 3 (три) рабочих дня. Но зависит от политики банка-эквайера, в котором обслуживается компания поставщика услуг и от банка-эмитента, в котором была выпущена карта. В обоих банках должна пройти процедура клиринга. Сумма возврата средств зависит от издержек поставщика услуг по процедуре возврата и обычно меньше суммы платежа.

Запрос содержит:

  • transaction_id - Идентификатор платежа в система PaySys
  • amount - Сумма возврата в центах доллара. Не может превышать сумму платежа
  • currency - Валюта платежа. Доступны валюты:
    UZS - Узбекский сум - валюта по умолчанию
    USD - Доллар США
    EUR - Евро
    RUB - Российский рубль
Пример запроса
{
  "method": "paysys.payment_adjustments",
  "params": {
        "transaction_id": 11422530,
        "amount": 100000,
        "currency": "UZS"
  },
  "id": "5c7294f7-3a76-40c9-b22c-d4ff0d7a27b9"
}

Ответ содержит:

  • transaction_id - Идентификатор транзакции в системе PaySys.
  • bank_transaction_id - Номер транзакции в системе PaySys.
  • vendor_user_id - Идентификатор заказа в система поставщика.
  • status - Статус транзакции.
Details
{
    "id": "5c7294f7-3a76-40c9-b22c-d4ff0d7a27b9",
    "error": null,
    "result": {
        "transaction_id": 11424156,
        "vendor_user_id": "1683530160817",
        "bank_transaction_id": 137664440,
        "status": 6
    },
    "mx_id": "588ffd16badd82e896f364935350f413"
}

В случае некорректных параметров запроса система вернет ошибку.

Получение фискальных чек (ссылки)​

Название метода: paysys.get_fiscal_cheque
Авторизация: требуется

Запрос содержит:

  • transaction_id - Идентификатор платежа в система PaySys
  • type - Тип транзакции.
    payment - Оплата
    p2p - Перевод
Пример запроса
{
  "method": "paysys.get_fiscal_cheque",
  "params": {
        "transaction_id": 11347050,
        "type": "payment"
  },
  "id": "3c14189b-5b7b-4c85-9901-b9cf7b1b5924"
}

Ответ содержит:

  • transaction_id - Идентификатор транзакции в системе PaySys.
  • cheque - Cсылка на чек.
Details
{
    "id": "3c14189b-5b7b-4c85-9901-b9cf7b1b5924",
    "error": null,
    "result": {
        "transaction_id": 11347050,
        "cheque": "https://ofd.soliq.uz/epi?t=EP000000000058&r=1020387&c=20230504110437&s=088681055845"
    },
    "mx_id": "588ffd16badd82e896f364935350f413"
}

В случае некорректных параметров запроса система вернет ошибку.

Создание инвойса​

Метод позволяет сгенерировать поставщику услуг, ссылку на оплату, и отправлять её плательщку различными способами.

Название метода: paysys.invoice_create
Авторизация: требуется

Запрос содержит:

  • order_id - ID заказа на стороне поставщика услуг
  • vendor_id - Идентификатор поставщика в система PaySys
  • payment_id - Идентификатор платежный система в система PaySys
    -1 - PaySys
  • currency - Валюта
    USD
    RUB
    UZS
    EUR
    TRL
  • amount - Сумма
  • order_note - Описание услуги, которая будет отображаться в списке транзакций в кабинете поставщика услуг
Пример запроса
{
  "method": "paysys.invoice_create",
  "params": {
    "order_id": "21258855-d57e-4c7c-9b7b-2215f9d1c992",
    "vendor_id": 104466,
    "payment_id": -1,
    "currency": "UZS",
    "amount": 1000.22,
    "order_note": "Payment for tickets"
  },
  "id": "6d8f5743-a4e8-4074-85de-8250d8f1c426"
}

Ответ содержит:

  • id - Идентификатор инвойса в системе PaySys.
  • vendor_id - ID поставщика в системе PaySys.
  • payment_id - Идентификатор платежной системы в системе PaySys.
    -1 - PaySys
  • order_id - ID заказа на стороне поставщика услуг
  • amount - Сумма.
  • currency - Валюта
    USD
    RUB
    UZS
    EUR
    TRL
  • status - Статус инвойс в система PaySys.
    -1 - Ошибка
    0 - Созданно
    1 - В проссес оплаты
    2 - Успешно
    3 - Отмена
  • order_note -Описание услуги, которая будет отображаться в списке транзакций в кабинете поставщика услуг
  • payment_url - Сгенерирования ссылка на оплату
  • hash - Идентификатор ссылки.
  • date - Дата создания инвойса в секундах
Details
{
  "id": "6d8f5743-a4e8-4074-85de-8250d8f1c426",
  "error": null,
  "result": {
    "id": 2693603,
    "vendor_id": 104466,
    "payment_id": -1,
    "order_id": "21258855-d57e-4c7c-9b7b-2215f9d1c992",
    "amount": "1000.22",
    "currency": "UZS",
    "status": 0,
    "order_note": "Payment for tickets",
    "payment_url": "https://paysys.uz/payform?hash=22c1c9ac0f85522db3a07b089be13e7f",
    "hash": "22c1c9ac0f85522db3a07b089be13e7f",
    "date": 1690547824
  },
  "mx_id": "20f479b1539b8bcb841561524c954ab3"
}

В случае некорректных параметров запроса система вернет ошибку.