Перейти к содержанию

Принять покупку

Параметры запроса

Параметры                        Тип Обязательный Описание
version string(10) необязательный Версия протокола.
Значение по умолчанию: 1.0.1
Версия 1.0 устарела
order_id string(1024) обязательный Идентификатор заказа, сгенерированный мерчантом
merchant_id integer(12) обязательный Уникальный идентификатор мерчанта. Генерируется Paymeпри регистрации мерчанта
order_desc string(1024) обязательный Описание заказа. Сгенерировано продавцом в кодировке UTF-8 всегда
amount integer(12) обязательный Сумма заказа без разделителя
currency string(3) обязательный Валюта заказа. Поддерживаемые значения:
AMD — армянский драм
AZN — азербайджанский манат
KZT — тенге
MDL — молдавский лей
GEL — грузинский лари
UZS — узбекский сум
Полный список поддерживаемых валют
response_url string(2048) необязательный URL сайта продавца, на который клиент будет перенаправлен после завершения оплаты
server_callback_url string(2048) необязательный URL сайта продавца, на который будет отправлен обратный вызов host-to-host после завершения платежа. Подробнее об обратных вызовах см. Callbacks .
signature string(40) обязательный Подпись заказа. Требуется для проверки согласованности и подлинности запроса мерчанта. Алгоритм генерации подписи см. на Генерация подписи для запроса и ответа
lifetime integer(9) необязательный Срок действия заказа в секундах. По истечении этого периода статус заказа изменится на «expired», если клиент не оплатил его
Значение по умолчанию: 36000
Максимально допустимое значение: 69120000
merchant_data string(2048) необязательный Любой произвольный набор данных, который мерчант хочет получить в ответе на запросы response_url и/или server_callback_url, а также в отчетах
preauth string(1) необязательный Параметр поддерживается только для способа оплаты Visa/MasterCard
N — сумма списывается с карты клиента немедленно и зачисляется на счет продавца в соответствии с правилами расчетов.
Y — сумма удерживается на счете карты клиента и не списывается до тех пор, пока продавец не отправит запрос capture для подтверждения.
Значение по умолчанию: N
sender_email string(256) необязательный Customer email
delayed string(1) необязательный Флаг отложенного заказа .
Y — позволяет клиенту оплатить заказ в течение периода, указанного продавцом в параметре lifetime. Продавец должен ожидать нескольких обратных вызовов между хостами и перенаправлений браузера в рамках одного заказа. У клиента будет возможность повторить попытку оплаты того же order_id, если предыдущая попытка завершилась неудачей
N — после отказа в оплате order_id клиент будет перенаправлен на сайт продавца для повторного создания заказа. В этом случае будет отправлен только один обратный вызов на server_callback_url
Значение по умолчанию: Y
lang string(2) необязательный Язык страницы оплаты. Поддерживаемые значения:
az – азербайджанский
da – датский
nl – голландский
fi – финский
ka – грузинский
ko – корейский
ru – русский
zh – китайский
uk – украинский
en – английский
lv – латышский
fr – французский
cs – чешский
ro – румынский
it – итальянский
sk – словацкий
pl – польский
es – испанский
hu – венгерский
de – немецкий
product_id string(1024) необязательный Идентификатор товара или услуги продавца
required_rectoken string(1) необязательный Флаг, указывающий, будет ли токен карты возвращен в ответе. См. Recuring payment
Значение по умолчанию: N
verification string(1) необязательный Если отправлено Y, заказ будет автоматически отменен после успешного одобрения
Значение по умолчанию: N
rectoken string(40) необязательный Токен карты для повторяющихся транзакций.
receiver_rectoken string(40) необязательный Токен карты для транзакций выплаты.
design_id string(6) необязательный ID дизайна оформления заказа, который задается в портале продавца
subscription string(1) необязательный Y – включить запланированные платежи
N – по умолчанию отключить запланированные платежи
subscription_callback_url string(2048) необязательный URL сайта продавца, куда будет отправлен обратный вызов host-to-host после завершения запланированного платежа
chargeback_callback_url string(2048) необязательный URL для обратных вызовов по возвратным платежам
cancel_url string(2048) необязательный URL-адрес, на который будет перенаправлен клиент, если он нажмет кнопку «Отменить» на странице оформления заказа
reservation_data string(10000) необязательный Данные JSON в кодировке BASE64, см. Дополнительные данные страница с подробностями
Параметры                        Тип Описание
order_id string(1024) Идентификатор заказа, сгенерированный мерчантом.
merchant_id integer(12) Уникальный идентификатор мерчанта. Генерируется Paymeво время регистрации мерчанта.
amount integer(12) Сумма заказа в центах без разделителя
currency string(3) Валюта заказа. Поддерживаемые значения: см. Currencies
order_status string(50) Статус обработки заказа. Может содержать следующие значения:
created — заказ создан, но клиент еще не ввел платежные данные; мерчант должен продолжать запрашивать статус заказа
processing — заказ все еще обрабатывается платежным шлюзом; продавец должен продолжать запрашивать статус заказа
declined — заказ отклонен платежным шлюзом Payme, банком или внешней платежной системой
approved — заказ успешно завершен, средства удержаны на счете плательщика и вскоре будут зачислены продавцу; продавец может предоставить услугу или отправить товар
expired — срок действия заказа lifetime истек.
reversed — ранее одобренная транзакция была полностью отменена. В этом случае параметр reversal_amount будет равен actual_amount
response_status string(50) Статус обработки запроса. Если параметры, отправленные мерчантом, не прошли валидацию, то статус — «failure», в противном случае — «success»
signature string(40) Подпись заказа. Требуется для проверки согласованности и подлинности запроса мерчанта. Алгоритм генерации подписи см. по адресу Генерация подписи для запроса и ответа и response
tran_type string(50) Поддерживаемые значения:
purchase
verification
p2p credit
p2p transfer
settlement — разделенные платежи
reverse
sender_cell_phone string(16) Номер мобильного телефона клиента
sender_account string(16) Платежный счет клиента
masked_card string(19) Маскированный номер карты
card_bin integer(6) Код карты — обычно первые 6 цифр 444444r
card_type string(50) Поддерживаемые значения:
VISA, MasterCard, Humo, UzCard
rrn string(50) Как правило, не уникальный идентификатор транзакции, возвращаемый банком.
approval_code string(6) Как правило, не уникальный код авторизации, возвращаемый банком.
response_code integer(4) Код ответа об отклонении заказа. Возможные коды см. в разделе «Коды ответов»
response_description string(1024) Описание кодов ответов на запросы, см. Коды ответов
reversal_amount integer(12) Общая сумма всех отмен для текущего заказа
settlement_amount integer(12) Сумма расчета по текущему заказу
settlement_currency string(3) Валюта расчета заказа
order_time string(19) Дата создания заказа DD.MM.YYYY hh:mm:ss
settlement_date string(10) Дата расчета в формате DD.MM.YYYY
eci integer(2) Показатель электронной коммерции — параметр указывает, была ли выполнена аутентификация 3DSecure. Поддерживаемые значения:
5 — выполнена полная аутентификация 3DSecure
6 — мерчант поддерживает 3DSecure, но банк-эмитент — нет
7 — ни мерчант, ни банк-эмитент не поддерживают 3DSecure
fee integer(12) Комиссия, взимаемая Payme
payment_system string(50) Платежная система, которая использовалась для оплаты. Список поддерживаемых платежных систем см. на Поддерживаемые платежные системы
sender_email string(254) Электронная почта клиента
payment_id integer(19) Уникальный идентификатор платежа, сгенерированный платежным шлюзом Payme
actual_amount integer(12) Фактическая сумма, удержанная или списанная с карты.
actual_currency string(3) Фактическая валюта, авторизованная с карты
product_id string(1024) Идентификатор товара или услуги продавца
merchant_data string(2048) Любой произвольный набор данных, который мерчант отправляет в запросе
verification_status string(50) Результат проверки кода.
Поддерживаемые значения:
verified — карта успешно проверена с помощью кода
incorrect — введен неверный код, но лимит еще не превышен
failed — превышено допустимое количество неверных попыток ввода кода
created — код проверки создан, но еще не введен
rectoken string(40) Флаг, указывающий, должен ли Paymeвозвращать токен карты — токен для доступа к средствам на карте без взаимодействия с держателем карты
rectoken_lifetime string(19) Срок действия токена в формате DD.MM.YYYY hh:mm:ss
additional_info string(20480) Дополнительное поле в формате JSON
{
"bank_name": "Some bank in US country",
"bank_country": "US",
"bank_response_code": "decln_1000",
"card_product": "DEBIT",
"card_category": "CLASSIC",
"settlement_fee": 0.2,
"capture_status": "captured",
"client_fee": 0.3,
"ipaddress_v4": "8.8.8.8",
"capture_amount": 200,
"card_type": "VISA",
"reservation_data": null,
"bank_response_description": "General decline",
"transaction_id": 1058755083,
"timeend":"10.01.2018 11:21:30",
"payment_method": "apple" or "googlepay" or "card",
"schemeid":"M11111111111111",
"masked_iban":"GE40XB**8712"
}

Примеры

{
  "request": {
    "version": "1.0.1",
    "order_id": "TestOrder2",
    "merchant_id": 4056281,
    "order_desc": "Test payment",
    "amount": 1000,
    "currency": "UZS",
    "response_url": "http://myshop/thank_you_page",
    "server_callback_url": "http://myshop/callback/",
    "signature": "91ea7da493a8367410fe3d7f877fb5e0ed666490"
  }
}
{
  "response": {
    "rrn": "111111111111",
    "masked_card": "444455XXXXXX1111",
    "sender_cell_phone": "",
    "sender_account": "",
    "currency": "UZS",
    "fee": "",
    "reversal_amount": "0",
    "settlement_amount": "0",
    "actual_amount": "200",
    "response_description": "",
    "sender_email": "test@test.com",
    "order_status": "approved",
    "response_status": "success",
    "order_time": "13.07.2024 01:23:59",
    "actual_currency": "UZS",
    "order_id": "test33694502191",
    "tran_type": "purchase",
    "eci": "5",
    "settlement_date": "",
    "payment_system": "card",
    "approval_code": "123456",
    "merchant_id": 4056281,
    "settlement_currency": "",
    "payment_id": 805243692,
    "card_bin": 444455,
    "response_code": "",
    "card_type": "VISA",
    "amount": "200",
    "signature": "b7884b5c4906956fbac4d20390388d913a78c0b0",
    "product_id": "",
    "merchant_data": "Test merchant data",
    "rectoken": "",
    "rectoken_lifetime": "",
    "verification_status": "",
    "parent_order_id": "",
    "fee_oplata": "0",
    "additional_info": "{\"capture_status\": null, \"capture_amount\": null, \"reservation_data\": \"{}\", \"transaction_id\": 1994930931, \"bank_response_code\": null, \"bank_response_description\": null, \"client_fee\": 0.0, \"settlement_fee\": 0.0, \"bank_name\": null, \"bank_country\": null, \"card_type\": \"VISA\", \"card_product\": \"empty_visa\", \"card_category\": null, \"timeend\": \"13.07.2024 01:24:08\", \"ipaddress_v4\": \"178.54.60.26\", \"payment_method\": \"card\", \"version_3ds\": 1, \"is_test\": true}",
    "response_signature_string": "**********|200|UZS|{\"capture_status\": null, \"capture_amount\": null, \"reservation_data\": \"{}\", \"transaction_id\": 1994930931, \"bank_response_code\": null, \"bank_response_description\": null, \"client_fee\": 0.0, \"settlement_fee\": 0.0, \"bank_name\": null, \"bank_country\": null, \"card_type\": \"VISA\", \"card_product\": \"empty_visa\", \"card_category\": null, \"timeend\": \"13.07.2024 01:24:08\", \"ipaddress_v4\": \"178.54.60.26\", \"payment_method\": \"card\", \"version_3ds\": 1, \"is_**********\": true}|200|123456|444455|VISA|UZS|5|0|444455XXXXXX1111|Test merchant data|4056281|**********33694502191|approved|13.07.2024 01:23:59|805243692|card|success|0|111111111111|**********@**********.com|0|purchase"
  }
}
{
    "response": {
        "error_code": 1011,
        "error_message": "Parameter `amount` is missing",
        "request_id": "5htKi0wf7zEHn",
        "response_status": "failure"
    }
}