Links

Запросы API v1.0.0

Кошелёк Pay API
В следующих версиях документа в запросы и/или ответы могут быть добавлены новые необязательные поля.
Для обеспечения обратной совместимости необходимо игнорировать их при формировании запросов и при приеме ответов от сервера до внесения соответствующих изменений в ПО, работающее на стороне ТСП.

Запрос списка возможных провайдеров платежей

HTTP-метод: POST
URL: /api/v1/merchant/availability-info/task

Описание

ТСП передает Кошельку информацию о счете к оплате и создает задачу на получение данных о провайдерах платежей.
В зависимости от кода ответа на запрос определяется способ получения списка провайдеров платежей:
1) Синхронный: ответ на вызов содержит HTTP Status Code 200. При этом в теле ответа содержатся непосредственно запрашиваемые данные о провайдерах платежей.
2) Асинхронный: ответ на вызов содержит HTTP Status Code 201. При этом в теле ответа будет содержаться поле availabilityInfoId, а в HTTP-заголовке Location — URL, который необходимо периодически опрашивать для получения данных о провайдере, используя запрос /api/v1/merchant/availability-info/{availabilityInfoId}.
Принципы получения списка доступных провайдеров платежей

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

Параметры заголовка запроса

Параметр
Тип
Обязательно
Значение
token
String
Да
Состоит из значения параметраcashFingerPrint и парольной части TOTP. Значение получается от модуля Кошелёк TOTP, развернутого на кассовом сервере ТСП (см. Модуль Кошелёк TOTP).
Пример заголовка запроса
Параметры тела запроса
Тело запроса передается в виде объекта JSON следующей структуры:
Поле
Тип
Обязательно
Значение
requestId
String
Да
Уникальный идентификатор запроса
(GUID, 36 символов).
Если по каким-либо причинам ответ на запрос не получен от Кошелька, то можно отправить этот запрос повторно, используя то же самое значение параметра requestId (действует правило идемпотентности).
cardSession
String
Да
Идентификатор сессии, извлеченный ТСП из штрихкода при сканировании карты или с информацией о QR-коде (не более 32 символов, латинские буквы и цифры, либо 6 символов для одномерных штрихкодов).
storeId
String
Да
Идентификтор ТСП, выданный Cardsmobile при его подключении (GUID, 36 символов).
terminalId
String
Да
Идентификатор кассы (256 символов).
checkoutInvoice
Object CheckoutInvoice
Да
Информация о пречеке. См. объект CheckoutInvoice.
user
Object User
Да
Информация о пользователе. См. объект User.
Пример тела запроса

Параметры ответа

HTTP Status Code: 200

Запрос выполнен успешно, ответ содержит сведения о списке провайдеров платежей (используется синхронный режим).
Тело ответа — объект JSON следующей структуры:
Пoле
Тип
Обязательно
Значение
koshelekPayIsDefault
Boolean
Да
Флаг автоматического выбора и запуска на кассе оплаты через Кошелёк Pay по умолчанию.
Если true, то в списке провайдеров платежей paymentTypeAvailabilityInfoList всегда будет хотя бы один доступный (available= true).
paymentTypeAvailabilityInfoList
Да
Массив, содержащий в себе список доступных провайдеров платежей (см. объект paymentTypeAvailabilityInfo)
Пример тела ответа

HTTP Status Code: 201

Запрос выполнен успешно, ответ содержит сведения для отдельного запроса на получение списка доступных провайдеров платежей (используется асинхронный режим).
Заголовок ответа:
Location: /api/v1/merchant/availability-info/{availabilityInfoId}
Тело ответа — объект JSON следующей структуры:
Поле
Тип
Обязательно
Значение
availabilityInfoId
String
Да
Идентификатор, по которому можно запросить информацию о списке доступных провайдеров платежей.
timeout
Integer
Да
Время, через которое необходимо осуществить первую проверку статуса готовности в запросе /availability-info/{availabilityInfoId}
Пример тела ответа

HTTP Status Code: 422

Запрос не выполнен. Тело ответа — объект JSON, описывающий ошибку.

Получение списка доступных провайдеров платежей

HTTP-метод: GET
URL: /api/v1/merchant/availability-info/{availabilityInfoId}

Описание

ТСП запрашивает у Кошелька список доступных провайдеров платежей в асинхронном режиме, т. е. если запрос /api/v1/merchant/availability-info/task вернул HTTP Status Code 201.
В этом случае методы /api/v1/merchant/availability-info/task и /api/v1/merchant/availability-info/{availabilityInfoId} используются в паре (принцип периодического опроса — поллинга).
Необходимо последовательно:
1) вызвать api/v1/merchant/availability-info/task, получить availabilityInfoId __ (идентификатор, используя который, можно будет впоследствии получить данные), и timeout __ (время, через которое необходимо осуществить первую проверку статуса готовности)
2) вызывать метод api/v1/merchant/availability-info/{availabilityInfoId} с периодом ожидания, равным timeout для первого вызова и pollingTimeout для последующих вызовов до тех пор, пока в ответе поле computationComplete не будет содержать значение true).

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

Отсутствуют.

Параметры ответа

HTTP Status Code: 200

Запрос выполнен успешно. Тело ответа — объект JSON следующей структуры:
Поле
Тип
Обязательно
Значение
availabilityInfoId
String
Да
Идентификатор, полученный в запросе.
computationComplete
Boolean
Да
Готовность результата запроса:
true — готов;
false — не готов.
pollingTimeout
Long
Да
Инструкция от сервера: отправить повторный запрос через указанное время (в миллисекундах).
Передается, если computationComplete = false.
koshelekPayIsDefault
Boolean
Да
Флаг автоматического выбора и запуска на кассе оплаты через Кошелёк Pay по умолчанию.
Если true, то в списке провайдеров платежей paymentTypeAvailabilityInfoList всегда будет хотя бы один доступный (available= true).
paymentTypeAvailabilityInfoList
Да
Массив, содержащий в себе список доступных провайдеров платежей (см. объект paymentTypeAvailabilityInfo)
Пример тела ответа

HTTP Status Code: 422

Запрос не выполнен.
Тело ответа — объект JSON, описывающий ошибку.

Инициализация платежа

HTTP-метод: POST
URL: /api/v1/merchant/checkout

Описание

ТСП передает Кошельку информацию о счёте к оплате и значение cardSession пользователя, который должен оплатить этот счёт.

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

Параметры заголовка запроса

Параметр
Тип
Обязательно
Значение
token
String
Да
Состоит из значения параметраcashFingerPrint и парольной части TOTP. Значение получается от модуля Кошелёк TOTP, развернутого на кассовом сервере ТСП (см. Модуль Кошелёк TOTP).
Пример заголовка запроса
Параметры тела запроса
Тело запроса передается в виде объекта JSON следующей структуры:
Поле
Тип
Обязательно
Значение
requestId
String
Да
Уникальный идентификатор запроса
(GUID, не более 36 символов).
Если по каким-либо причинам ответ на запрос не получен от Кошелька, то можно отправить этот запрос повторно, используя то же самое значение параметра requestId (действует правило идемпотентности).
cardSession
String
Да
Идентификатор сессии, извлеченный ТСП из штрихкода при сканировании карты или с информацией о QR-коде (не более 32 символов, латинские буквы и цифры, либо 6 символов для одномерных штрихкодов).
storeId
String
Да
Идентификтор ТСП, выданный Cardsmobile при его подключении (GUID, 36 символов).
terminalId
String
Да
Идентификатор кассы (256 символов).
checkoutInvoice
Object CheckoutInvoice
Да
Информация о пречеке. См. объект CheckoutInvoice
user
Object User
Да
Информация о пользователе. См. объект User.
paymentMethods
Array of PaymentMethod
Да
Массив объектов, содержащий в себе информацию о способах оплаты, поддерживаемых ТСП. См. объект PaymentMethod.
Пример тела запроса

Параметры ответа

HTTP Status Code: 200

Запрос выполнен успешно.
Тело ответа — объект JSON следующей структуры:
Поле
Тип
Обязательно
Значение
requestId
String
Да
Уникальный идентификатор запроса.
transactionId
String
Да
Идентификатор транзакции.
status
Enum
Да
Статус транзакции:
new
canceled
pending
rejected
accepted
refunding
refunded
partial_refunded
slip
Object Slip
Зависит от значения поля status
Объект Slip, содержащий данные о проведенной банковской операции.
Будет возвращен, если операция оплаты была проведена через банк (статусы accepted, rejected), или если был проведен возврат оплаты (статусы refunded, partial_refunded).
Пример тела ответа

HTTP Status Code: 422

Запрос не выполнен. Тело ответа — объект JSON, описывающий ошибку.

Получение статуса транзакции

HTTP-метод: POST
URL: /api/v1/merchant/transaction/status

Описание

Ответ со статусами платежной транзакции и транзакции отмены. a. Реализация приема postback/callback ответов от Кошелька
ТСП необходимо реализовать на своей стороне метод, который будет вызывать сервер Кошелька для передачи ТСП статуса платежа. Этот способ получения статуса является предпочтительным, т.к. в данном случае сервер Кошелька сразу передает ТСП ответ, и ТСП не нужно работать в режиме polling c сервером Кошелька с запросом b в ожидании ответа с финальным статусом транзакции. Сервер Кошелька должен передавать при вызове метода тот же объект, который возвращает в response на вызов b. Схема работы через периодические вызовы метода b со стороны ТСП должна использоваться в случае технической невозможности подключения сервера Кошелька к серверу ТСП (или напрямую к кассам) для передачи ответов через postback. Request body: см. Response body в пункте b. b. Реализация подключения к методу получения статуса от сервера Кошелька.
Рекомендации по вызову метода
Статус транзакции необходимо запрашивать:
  1. 1.
    В первый раз: не раньше чем через 250 мс и не позже чем через 500 мс.
  2. 2.
    Дальнейшие вызовы должны быть не чаще чем раз в 250 мс.
  3. 3.
    Касса должна ожидать статус не дольше, чем 30 секунд, и вызывать отмену оплаты, если время ожидания превышено.
Конкретная реализация остается на усмотрение ТСП, но важно убедиться, что не остается никакого потока, который продолжает опрашивать серверы Кошелька.

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

Тело запроса передается в виде объекта JSON следующей структуры:
Поле
Тип
Обязательно
Значение
requestId
String
Да
Уникальный идентификатор запроса
(GUID, не более 36 символов).
Если по каким-либо причинам ответ на запрос не получен от Кошелька, то можно отправить этот запрос повторно, используя то же самое значение параметра requestId (действует правило идемпотентности).
transactionId
String
Нет
Идентификатор транзакции оплаты
(GUID, 36 символов).
Необязателен, если передается refTransactionId.
refTransactionId
String
Нет
Идентификатор транзакции отмены
(GUID, 36 символов).
Необязателен, если передается transactionId.
Пример тела запроса

Параметры ответа

HTTP Status Code: 200

Запрос выполнен успешно.
Тело ответа — объект JSON следующей структуры:
Поле
Тип
Обязательно
Значение
requestId
String
Да
Уникальный идентификатор запроса.
transactionId
String
Да
Идентификатор транзакции оплаты.
refTransactionId
String
Нет
Идентификатор транзакции отмены.
status
Enum
Да
Статус транзакции:
new
canceled
pending
rejected
accepted
refunding
refunded
partial_refunded
— или пустое значение, если указанный в запросе transactionId не найден.
paymentGroup
Enum
Да
Категория оплат:
INSTALLMENT — в рассрочку / частями.
SBP — через Систему быстрых платежей.
paymentProvider
Enum
Да
Тип провайдера:
DOLYAME — "Тинькофф Долями". SBP — СБП.
slip
Object Slip
Зависит от значения поля status
Объект Slip, содержащий данные о проведенной банковской операции.
Будет возвращен, если операция оплаты была проведена через банк (статусы accepted и rejected), или если был проведен возврат оплаты (статусы refunded и partial_refunded).
refStatus
Enum
Нет
Статус транзакции отмены:
new
rejected — отмена отклонена, оплата не возвращена покупателю.
accepted — отмена одобрена.
errorCode
Enum
Нет
Код ошибки, возникшей при выполнении операции оплаты или возврата. Параметр передается только для status или refStatus = "rejected". Описание возможных значений см. ниже.

Возможные значения параметра errorCode

1. Для сценария оплаты:
Значение
Описание
NOT_ENOUGH_LIMIT_TO_PAY
Превышен лимит для совершения операции.
TOTAL_AMOUNT_IS_TOO_SMALL
Сумма покупки ниже установленного лимита (составляет 4 рубля).
EXTERNAL_PROVIDER_ERROR
Общий код ошибки провайдера платежей.
SUBSCRIPTION_IS_NOT_FOUND
Привязанный счет пользователя не найден (платеж через СБП с привязанного счета пользователя).
PAYMENT_DECLINED_BY_EXTERNAL_PROVIDER
Платеж отклонен банком (платеж через СБП с привязанного счета пользователя).
2. Для сценария возврата:
Значение
Описание
PAYMENT_TRANSACTION_IS_NOT_PAID
Возврат отклонен, т.к. транзакция оплаты с данным transactionId не была завершена, списание средств не выполнялось.
TERMINAL_STATE_OF_PAYMENT_TRANSACTION
Возврат отклонен по одной из причин:
  • транзакция была отменена ранее, до списания средств;
  • транзакция уже была отклонена провайдером платежей до списания средств;
  • уже был выполнен полный возврат средств.
PAYMENT_TRANSACTION_IS_BEING_REFUNDED_ALREADY
Возврат отклонен, т.к. есть незавершенная транзакция отмены. Дождитесь завершения процесса возврата по транзакции отмены с refTransactionId незавершенной предыдущей транзакции отмены.
REQUESTED_REFUND_AMOUNT_IS_GREATER_THAN_AVAILABLE
Возврат отклонен, т.к. запрошенная сумма к возврату превышает сумму оплаты по транзакции оплаты с данным transactionId.
EXTERNAL_PROVIDER_ERROR
Общий код ошибки провайдера платежей.
UNEXPECTED_REFUND_AMOUNT_LEFT_FROM_EXTERNAL_PROVIDER
Возврат отклонен, т.к. транзакция оплаты с данным transactionId не была завершена, списание средств не выполнялось.
PAYMENT_ORDER_IS_NOT_FOUND
Только для транзакций СБП. Не найдено платежное поручение в банке ТСП при выполнении операции возврата.
Пример тела ответа

HTTP Status Code: 422

Запрос не выполнен. Тело ответа — объект JSON, описывающий ошибку.

Отправка чека

HTTP-метод: POST
URL: /api/v1/merchant/transaction/receipt

Описание

ТСП передает Кошельку информацию о фискальном чеке для его отображения пользователю в Кошельке.

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

Тело запроса передается в виде объекта JSON следующей структуры:
Поле
Тип
Обязательно
Значение
requestId
String
Да
Уникальный идентификатор запроса
(GUID, не более 36 символов).
Если по каким-либо причинам ответ на запрос не получен от Кошелька, то можно отправить этот запрос повторно, используя то же самое значение параметра requestId (действует правило идемпотентности).
transactionId
String
Да
Идентификатор транзакции оплаты
(GUID, 36 символов).
storeId
String
Да
Идентификтор ТСП, выданный Cardsmobile при его подключении (GUID, 36 символов).
terminalId
String
Да
Идентификатор кассы (256 символов).
invoice
Object Invoice
Да
Информация о счете в формате "ключ-значение". См. объект Invoice.
meta
Object
Нет
Объект, содержащий дополнительные поля, например: скидки, бонусы и т.д. (набор пар "ключ-значение").
Пример тела запроса

Параметры ответа

HTTP Status Code: 200

Запрос выполнен успешно. Тело ответа — пустое.

HTTP Status Code: 422

Запрос не выполнен. Тело ответа — объект JSON, описывающий ошибку.

Отмена оплаты

HTTP-метод: POST
URL: /api/v1/merchant/transaction/cancel

Описание

ТСП передает Кошельку запрос на отмену транзакции оплаты.
В запросе не указывается сумма отмены, т.к. операция отмены проводится на полную сумму, указанную в транзакции оплаты.

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

Тело запроса передается в виде объекта JSON следующей структуры:
Поле
Тип
Обязательно
Значение
requestId
String
Да
Уникальный идентификатор запроса
(GUID, не более 36 символов).
Если по каким-либо причинам ответ на запрос не получен от Кошелька, то можно отправить этот запрос повторно, используя то же самое значение параметра requestId (действует правило идемпотентности).
storeId
String
Да
Идентификтор ТСП, выданный Cardsmobile при его подключении (GUID, 36 символов).
terminalId
String
Да
Идентификатор кассы (256 символов).
transactionId
String
Да
Идентификатор транзакции оплаты
(GUID, 36 символов).
Пример тела запроса

Параметры ответа

HTTP Status Code: 200

Запрос выполнен успешно.
Тело ответа — объект JSON следующей структуры:
Поле
Тип
Обязательно
Значение
requestId
String
Да
Уникальный идентификатор запроса.
refTransactionId
String
Да
Идентификатор транзакции отмены.
refStatus
Enum
Да
Статус транзакции отмены:
new
rejected — отмена отклонена (перечень причин указан в таблице в описании сценария отмены).
accepted — отмена одобрена.
transactionId
String
Да
Идентификатор транзакции оплаты.
status
Enum
Да
Статус транзакции оплаты, в который она перешла после вызова отмены (или в котором она осталась, если отмена была отклонена):
new
canceled
pending
rejected
accepted
refunding
refunded
partial_refunded
none
slip
Object Slip
Зависит от значения поля status
Объект Slip, содержащий данные о проведенной банковской операции. Будет возвращен, если операция оплаты была проведена через банк (статусы accepted и rejected), или если был проведен возврат оплаты (статусы refunded и partial_refunded).
Пример тела ответа

HTTP Status Code: 422

Запрос не выполнен. Тело ответа — объект JSON, описывающий ошибку.

Возврат оплаты

HTTP-метод: POST
URL: /api/v1/merchant/transaction/refund

Описание

ТСП передает Кошельку запрос на возврат покупателю средств, полученных в результате транзакции оплаты.

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

Параметры заголовка запроса

Параметр
Тип
Обязательно
Значение
token
String
Да
Состоит из значения параметраcashFingerPrint и парольной части TOTP. Значение получается от модуля Кошелёк TOTP, развернутого на кассовом сервере ТСП (см. Модуль Кошелёк TOTP).
Пример заголовка запроса
Параметры тела запроса
Тело запроса передается в виде объекта JSON следующей структуры:
Поле
Тип
Обязательно
Значение
requestId
String
Да
Уникальный идентификатор запроса
(GUID, не более 36 символов).
Если по каким-либо причинам ответ на запрос не получен от Кошелька, то можно отправить этот запрос повторно, используя то же самое значение параметра requestId (действует правило идемпотентности).
storeId
String
Да
Идентификатор ТСП, выданный Cardsmobile при его подключении (GUID, 36 символов).
terminalId
String
Да
Идентификатор кассы (256 символов).
transactionId
String
Да
Идентификатор транзакции оплаты
(GUID, 36 символов).
refundAmount
Number
Да
Сумма возврата в копейках. Не должна превышать сумму оплаты. Только положительное значение.
items
Array of Item
Да
Массив товаров, включенных в возвращаемую покупку (каждый товар — объект Item).
Пример тела запроса

Параметры ответа

HTTP Status Code: 200

Запрос выполнен успешно.
Тело ответа — объект JSON следующей структуры:
Поле
Тип
Обязательно
Значение
requestId
String
Да
Уникальный идентификатор запроса.
refTransactionId
String
Да
Идентификатор транзакции возврата.
refStatus
Enum
Да
Статус транзакции возврата:
new
rejected — возврат отклонен.
accepted — возврат одобрен.
transactionId
String
Да
Идентификатор транзакции оплаты.
status
Enum
Да
Статус транзакции оплаты, в который она перешла после вызова отмены (или в котором она осталась, если отмена была отклонена):
new
canceled
pending
rejected
accepted
refunding
refunded
partial_refunded
none
slip
Object Slip
Нет
Объект Slip, содержащий данные о проведенной банковской операции. Будет возвращен, если операция оплаты уже была была проведена через банк (статусы accepted и rejected).
errorCode
Enum
Нет
Код ошибки, возникшей при выполнении операции возврата. Передается только для refStatus = "rejected". Возможные значения см. ниже.

Возможные значения параметра errorCode

Значение
Описание
PAYMENT_TRANSACTION_IS_NOT_PAID
Возврат отклонен, т.к. транзакция оплаты с данным transactionId не была завершена, списание средств не выполнялось.
TERMINAL_STATE_OF_PAYMENT_TRANSACTION
Возврат отклонен, т.к. транзакция:
  • была отменена ранее до списания средств;
  • уже была отклонена провайдером платежей до списания средств;
  • уже был выполнен полный возврат оплаченных средств.
PAYMENT_TRANSACTION_IS_BEING_REFUNDED_ALREADY
Возврат отклонен, т.к. уже есть незавершенная транзакция отмены. Дождитесь завершения процесса возврата по транзакции отмены с refTransactionId незавершенной предыдущей транзакции отмены.
REQUESTED_REFUND_AMOUNT_IS_GREATER_THAN_AVAILABLE
Возврат отклонен, т.к. запрошенная сумма к возврату превышает сумму оплаты по транзакции оплаты с данным transactionId
EXTERNAL_PROVIDER_ERROR
Общий код ошибки провайдера платежей
UNEXPECTED_REFUND_AMOUNT_LEFT_FROM_EXTERNAL_PROVIDER
Возврат отклонен, т.к. транзакция оплаты с данным transactionId не была завершена, списание средств не выполнялось.
PAYMENT_ORDER_IS_NOT_FOUND
Только для транзакций СБП. Не найдено платежное поручение в банке ТСП при выполнении операции возврата.
Пример тела ответа

HTTP Status Code: 422

Запрос не выполнен. Тело ответа — объект JSON, описывающий ошибку.