GetState
https://{Environment}.payture.com/vwapi/GetStateКоманда GetState используется для получения актуального статуса платежа.
Запрос
curl https://sandbox3.payture.com/vwapi/GetState \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Key=Merchant \
-d OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea \В запросах наименования параметров чувствительны к регистру
| Параметр | Описание | Формат |
|---|---|---|
| Key | Наименование платежного Терминала Предоставляется с параметрами тестового/рабочего доступа | String Mandatory |
| OrderId | Уникальный идентификатор платежа в системе Продавца Рекомендуемый формат: GUID/UUID или Alphanumeric. Другие форматы могут вызвать сбои в работе банковских сервисов. | String [1..50] Mandatory |
Ответ
XML строка с элементом GetState
Примеры ответов
<GetState Success="True" OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" State="Refunded" Forwarded="False" MerchantContract="Merchant" Amount="12480" RRN="003770024290" VWUserLgn="123@ya.ru" PANMask="521885xxxxxx5484"/>| Параметр | Описание | Формат |
|---|---|---|
| Success | Признак успешности операции (получения статуса). Принимает значения:True — заказ найден и статус полученFalse — не удалось выполнить запрос статуса | String Mandatory |
| OrderId | Идентификатор платежа в системе Продавца Соответствует переданному в запросе | String [1..50] Mandatory |
| Forwarded | Признак перенаправления платежа на другой Терминал | Boolean Mandatory |
| State | Статус платежа. См. статусы транзакций Передается, если «Success=True» | String Optional |
| MerchantContract | Наименование платежного Терминала Соответствует переданному в запросе. Передается, если «Success=True» | String [1..50] Optional |
| FinalTerminal | Конечный Терминал, на котором был выполнен платеж Передается, если «Forwarded=True» | String Optional |
| Amount | Сумма платежа в копейках (или другая минимальная единица валюты терминала) Передается, если «Success=True» | Integer Optional |
| RRN | Уникальный номер транзакции, присвоенный банком-эквайером (Retrieval Reference Number) Передается, если «Success=True» | String [12] Optional |
| VWUserLgn | Идентификатор Покупателя в системе Payture Передается, если «Success=True» | String [1..50] Optional |
| PANMask | Маскированный номер карты (первые 6 и последние 4 цифры: 123456хххххх1234) Передается, если «Success=True» | String [13..19] Optional |
| AddInfo | Дополнительные параметры транзакции, которые могут быть переданы в ответе платежного шлюза по согласованию со службой поддержки Payture Описание формата и возможных параметров доступно здесь | Object Optional |
| ErrCode | Код ошибки. См. коды ошибок Передается, если:«Success=True» + «Status=Rejected» – будет указан код ошибки платежа«Success=False» – будет указан код ошибки самого запроса статуса. | String Optional |
