Справочник API¶
Payme API предоставляет мощные инструменты для реализации сценариев онлайн-платежей. Вы можете разработать свой собственный платежный поток любой степени сложности простым способом с помощью Payme API: платежи по картам, 3DSecure, подписки), онлайн-банкинг, электронная фискализация и т. д.
API организовано вокруг потока запросов <-> ответов с кодировкой FORM или запросов <-> ответов с кодировкой JSON. Таким образом, вы можете Выберите FORM или JSON для тела запроса, а тело ответа будет иметь тот же формат, что и запрос.
Вы можете использовать API Payme в тестовом режиме без каких-либо ограничений функциональности. В зависимости от статуса мерчанта все запросы выполняются в соответствующем тестовом или продуктовом режиме. Тестовый режим никогда не влияет на ваши реальные финансы.
Аутентификация¶
Все запросы API должны отправляться по протоколу HTTPS с использованием метода POST.
Paymeиспользует параметр signature для аутентификации каждого запроса. Подпись представляет собой результат работы хеш-функции SHA1, сгенерированный мерчантом.
с помощью своего платежного ключа.
Используйте платежный ключ для создания подписи (signature) для каждого API-запроса в соответствии с разделом Создание подписи.
Пример запроса API:
curl -L 'https://pay.payme.uz/api/checkout/url' \
-H 'Content-Type: application/json' \
-d '{
"request": {
"server_callback_url": "...",
"order_id": "test_order1231",
"currency": "UZS",
"merchant_id": 4056281,
"order_desc": "Test payment",
"amount": 100,
"signature": "487690517384b11725ac02d37f79fe677174291f"
}
}'
Примечание
Когда ваш мерчант находится в тестовом режиме, ответ может содержать дополнительный параметр response_signature_string, который будет отсутствовать
в режиме реального времени. Это полезно для анализа причин, по которым запрос отклоняется из-за неверной подписи, встроенной в запрос.
Предупреждение
Не отправляйте конфиденциальную информацию в API Payme с тестовым платежным ключом и мерчантом, взятыми из раздела «Тестовый режим» (](testing.md)) на сайте [.
Отказы и ошибки¶
Нормальный ответ означает, что запрос обработан успешно. Нормальный ответ содержит "response_status": "success"
Стандартный ответ
{
"response": {
"checkout_url": "https://pay.payme.uz/merchants/..../index.html?token=...",
"payment_id": "738303484",
"response_status": "success"
}
}
Decline — это нормальный ответ, когда запрос обработан успешно, но платеж отклонен по какой-либо причине. Ответ
с отклоненным платежом содержит параметры response_code и response_description. Пожалуйста,
См. раздел «Коды ответов» (](response-codes.md)) на сайте [.
Стандартный ответ with decline
{
"response": {
"rrn": "",
"masked_card": "444411XXXXXX6666",
"sender_cell_phone": "",
"sender_account": "",
"currency": "UZS",
"fee": "",
"reversal_amount": "0",
"settlement_amount": "0",
"actual_amount": "",
"response_description": "General decline",
"sender_email": "",
"order_status": "declined",
"response_status": "success",
"order_time": "27.09.2022 22:43:38",
"actual_currency": "",
"order_id": "TestOrder238947272719",
"tran_type": "purchase",
"eci": "",
"settlement_date": "",
"payment_system": "card",
"approval_code": "",
"merchant_id": 4056281,
"settlement_currency": "",
"payment_id": 526886172,
"card_bin": 444411,
"response_code": 1000,
"card_type": "VISA",
"amount": "200",
"signature": "fd5d3d61698ad80e91415eea42180db91b90fddd",
"product_id": "",
"merchant_data": "",
"rectoken": "",
"rectoken_lifetime": "",
"verification_status": "",
"parent_order_id": ""
}
}
Error возвращается в ответе, когда платежный шлюз Paymeне может обработать запрос. В этом случае ответ
содержит параметры error_message и error_code, а также "response_status": "failure".
Response with error
{
"response": {
"error_code": 1011,
"error_message": "Parameter `amount` is missing",
"request_id": "eZIT2An0VLAY2",
"response_status": "failure"
}
}