[POST] Авторизация карты
Описание запроса
POST /v1/payment/card/verification
Запрос предназначен для авторизации карты для ранее созданного платежа. Под авторизацией подразумевается проверка действительности платежной карты. В процессе выполнения с карты может быть списана незначительная сумма, которая будет автоматически возвращена после завершения обработки авторизации.
Сценарии использования:
Условия начала обработки запроса:
- Платеж, для которого выполняется авторизация карты, создан и имеет следующие свойства:
- Зарегистрирован в качестве родительского платежа (при создании было передано поле
"recurring_indicator":true
). - Сумма платежа равна нулю.
- Платежный метод поддерживает оплату картой (код платежного метода: CreditCard)
- Статус обработки: not paid.
- Зарегистрирован в качестве родительского платежа (при создании было передано поле
Проверка результата авторизации выполняется отдельно, см. описание в сценариях.
Данные для отправки запроса
- Endpoints URL:
- Метод: POST
- Формат: JSON
- Авторизация: с помощью токена
- Формат значения:
Bearer [token]
- Вместо [token] подставьте значение token, полученное в ответ на запрос к Authentication API.
Вы получаете этот идентификатор в ответ на запрос создания платежа.
- Формат: только цифры, от 1 до 19 символов.
- При обработке запроса проверяется только соответствие формату.
- Формат: только цифры, 4 символа.
- Год должен быть больше или равен текущему.
- Формат: только цифры, 1 или 2 символа. Правильно: 1, 2, 3, ..., неправильно: 01, 02, 03, ...
- Месяц и год должны быть больше или равны текущим.
- Формат: не более 150 символов.
- Рекомендуется использовать только латинские символы и пробел (регистр не имеет значения). В ином случае карта может не пройти верификацию при проведении оплаты. При обработке запроса проверяется только соответствие требованиям формата.
Пример запроса
{
"order_id": 5555555,
"card": {
"pan": "4111111111111111",
"year": 2026,
"month": 12,
"card_holder": "IVAN PETROV",
"cvv": "111"
}
}
Ответ на запрос
В ответ на запрос вы получите код ответа сервера, соответствующий результату обработки.
В зависимости от кода в теле ответа могут присутствовать дополнительные параметры.
Положительный ответ
При успешной обработке запроса вы получите код ответа сервера HTTP/1.1 200 OK.
Этот ответ обозначает, что на стороне Softline Payments инициирована авторизация карты. Чтобы узнать о результатах авторизации подождите пока придет webhook уведомление или проверьте статус платежа с помощью запроса получения данных о платеже.
Ответ об ошибке
В случае ошибки при обработке запроса вы получите код ответа сервера, соответствующий результату обработки.
В зависимости от кода в теле ответа могут присутствовать дополнительные параметры.
Справочник HTTP-кодов ответа сервера при ошибке
Код ответа сервера | Описание |
HTTP/1.1 400 Bad Request | Запрос не валиден (ошибка в параметрах; не переданы необходимые данные и т.п.). В теле ответа будет передан дополнительный код ошибки (один или несколько). |
HTTP/1.1 401 Unauthorized | Неуспешная аутентификация. В теле ответа будет передан дополнительный код ошибки (один или несколько). |
HTTP/1.1 404 Not found | Неверный URL запроса или не найден платеж. Проверьте адрес запроса. В теле ответа может быть передан дополнительный код ошибки (один или несколько). |
HTTP/1.1 500 Request Error | Ошибка на стороне сервера. Повторите запрос позднее или обратитесь в службу поддержки. |
Справочник дополнительных кодов ошибок для HTTP 400
Error | Message | Описание |
Если хотя бы одна ошибка из списка ниже найдена, то она возвращается в ответе на запрос, остальные ошибки не проверяются. | ||
110 | JSON is not valid. | Авторизация карты не может быть выполнена. Структура полей запроса не валидна. Проверьте поля в теле запроса на соответствие формату JSON. |
111 | Invalid data format (Content-type). | Авторизация карты не может быть выполнена. Неправильный заголовок запроса. Content-type должен быть равен application/json. |
Если хотя бы одна ошибка из списка ниже найдена, то проверка запроса не прерывается. В ответе может быть возвращено несколько ошибок. |
||
6010 | Invalid field value: [наименование параметра] | Запрос не валиден, например, не заполнен обязательный параметр, передано неверное название параметра, тип или формат значения параметра неверны. В том числе ошибка будет возвращена, если в параметре передано null, и этот вариант значения не указан как допустимый. |
6420 | Card verification is unavailable. Payment [order_id] has been deleted. | Авторизация карты не может быть выполнена. Платеж с переданным идентификатором (order_id) был успешно выполнен (имеет статус paid). Авторизацию карты можно выполнить только для платежа в статусе not paid. |
6430 | Card verification is unavailable. Payment [order_id] has been deleted. | Авторизация карты не может быть выполнена. Платеж с переданным идентификатором (order_id) был удален (имеет статус deleted). Авторизацию карты можно выполнить только для платежа в статусе not paid. |
6440 | Card verification is unavailable. For payment [order_id], the following payment method is set: [payment_method]. | Авторизация карты не может быть выполнена. В платеже с переданным идентификатором (order_id) установлен метод оплаты не поддерживающий проведение авторизации карты. В ответе будет возвращен код текущего платежного метода из платежа. |
6450 | Card verification is unavailable. Parameter recurring_indicator = true has not been set for payment [order_id]. | Авторизация карты не может быть выполнена. Платеж с переданным идентификатором (order_id) не зарегистрирован в качестве родительского (recurring_indicator не равен true). |
6460 | Card verification is unavailable. Payment amount [order_id] must be equal to zero. | Оплата не может быть выполнена. Платеж с переданным идентификатором (order_id) имеет сумму не равную нулю. Для проведения оплаты сумма должна быть равна нуля. |
6470 | Invalid card expiration date. | Авторизация карты не может быть выполнена. Дата завершения срока действия карты (month/year) не отвечает требованиям. |
Справочник дополнительных кодов ошибок для HTTP 401
Справочник этих ошибок одинаковый для всех API, которые используют авторизацию по токену.
Справочник дополнительных кодов ошибок для HTTP 404
Error | Message | Описание |
Если хотя бы одна ошибка из списка ниже найдена, то она возвращается в ответе на запрос, остальные ошибки не проверяются. | ||
6400 | Payment [order_id] is not found. | Авторизация карты не может быть выполнена. Платеж с переданным идентификатором (order_id) не найден или у вас нет прав на выполнение операции с ним. |
Пример ответа об ошибке
{
"errors": [{
"error": 6350,
"message": "Invalid field value: card.month."
}
]
}