Запрос на оплату

Вы можете отправлять запросы на оплату с использованием Odero API для успешных или неудачных оплат, совершенных ранее.

URL

Информация о конечной точке и методе HTTP, используемых для запроса оплаты, предоставлена ниже:

HTTP Metod URL
GET /payment-reporting/v1/payments/:id

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

Запрос на оплату можно выполнить, просто используя идентификатор оплаты.

Название параметра Тип Обязательный Описание
id integer Да ID оплаты, указанный в запросе

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

Параметры, возвращаемые после операции оплаты через Общую страницу оплаты, должны соответствовать правилам, указанным в разделе Форматы возврата на главной странице API-документации. Если нет системных или организационных ошибок, параметры возвращаемого объекта в data выглядят следующим образом:

Название параметра Тип Всегда присутствует Описание
id long Да ID операции оплаты
createdDate date Да Дата первоначального создания оплаты
updatedDate date Да Дата обновления оплаты
orderId string Да Уникальный идентификатор, созданный Odero связанный с оплатой. Создается Odero для операций, связанных с кошельком или банком.
price decimal Да Общая сумма оплаты в корзине
paidPrice decimal Да Оплаченная общая сумма
walletPrice decimal Да Сумма, удержанная из кошелька
paymentType PaymentType Да см. Типы оплат
currency Currency Да см. Валюты
paymentStatus PaymentStatus Да см. Статусы платежа
conversationId string Нет Значение conversationId, отправленное бизнесом в запросе оплаты
paymentCard PaymentCard Да (см. Информация о карте и комиссионных сборах платежа) Информация о карте и комиссионных сборах, связанных с платежом
paymentRefunds PaymentRefund[] Да (см. Информация о возврате платежа) Список возвратов, связанных с платежом
paymentTransactions PaymentTransaction[] Да (см. Информация о транзакциях платежа) Детали элементов, включенных в платеж

Информация о карте и комиссионных сборах платежа

Отправляется вместе со всеми платежами, включая полный баланс кошелька.

Имя параметра Тип Всегда доступен Описание
cardType CardType Нет (смотрите: Типы карт) Присутствует при полном или частичном удержании средств с карты. Обозначает тип карты
cardAssociation CardAssociation Нет (смотрите: Карточные ассоциации) Присутствует при полном или частичном удержании средств с карты. Указывает на организацию, к которой привязана карта
cardBrand string Нет Присутствует при полном или частичном удержании средств с карты. Соответствует значению cardBrand в данных карты, отправленных в запросе для платежа
cardHolderName string Нет Присутствует при полном или частичном удержании средств с карты. Отражает имя и фамилию владельца карты
binNumber string Нет Присутствует при полном или частичном удержании средств с карты. Отражает первые 6 цифр номера карты
lastFourDigits string Нет Присутствует при полном или частичном удержании средств с карты. Отражает последние 4 цифры номера карты
installment integer Да Отражает количество платежей по счету. Допустимые значения: 1, 2, 3, 6, 9 и 12
isThreeDS boolean Нет Присутствует при полном или частичном удержании средств с карты. Отражает, был ли платеж проведен с использованием 3D Secure
mdStatus integer Нет (смотрите: MD Status) Присутствует при полном или частичном удержании средств с карты, проведенном с использованием 3D Secure. Отражает статус подтверждения 3D Secure
pfCommissionRateAmount decimal Да Сумма комиссии, взимаемой Odero в качестве платежного посредника за платеж
merchantCommissionRate decimal Да Процент комиссии, применяемой участником бизнеса к платежу
merchantCommissionRateAmount decimal Да Общая сумма комиссии, взимаемой участником бизнеса за платеж
error Error Нет (смотрите: Информация об ошибке) Присутствует при обработке платежей, завершившихся с ошибкой. Содержит информацию об ошибке

Информация о Возврате Оплаты

Содержит подробную информацию о полностью возвращенных платежах. Параметры, входящие в эту информацию, структурированы в таблице ниже:

Название параметра Тип Всегда присутствует Описание
id long Да ID операции по возврату, созданный Odero
createdDate date Да Дата возврата
refundStatus string Да см. Статусы возврата
refundDestinationType RefundDestinationType Да см. Типы возврата
price decimal Да Отмененная сумма
refundBankPrice decimal Да Возвращенная на карту после отмены
refundWalletPrice decimal Отмена Возвращенная на кошелек после отмены
conversationId string Да Значение conversationId, отправленное бизнесом в запросе на отмену
paymentType PaymentType Да (см. Типы платежей) Тип удержания отмененного платежа
error Error Нет (см. Информация об ошибке) Присутствует в случае неудачной отмены. Содержит информацию об ошибке

Информация о разделе Оплаты

Здесь содержатся сведения о разделенных оплатах. Эти данные включают определение стоимости оплаты и информацию о перемещении средств и возможных пунктах возврата средств на основе этих разделений.

Название параметра Тип Всегда присутствует Описание
id long Да ID разделенной оплаты
createdDate date Да Дата создания разделенной оплаты
externalId string Нет Внешний идентификатор, связанный с разделенной оплатой, отправленной в запросе оплаты
transactionStatus TransactionStatus Да (см. Статусы отправки денег) Значение, обозначающее статус отправки денег, связанный с разделенной оплатой
transactionStatusDate date Да Дата последнего изменения статуса отправки денег, связанного с разделенной оплатой
price decimal Да Сумма разделенной оплаты в корзине
paidPrice decimal Да Доля общей суммы, удержанной для оплаты
walletPrice decimal Да Доля общей суммы, удержанной из кошелька для оплаты
merchantPayoutAmount decimal Да Доля суммы, отправляемой торговцу в связи с оплатой, причисленной к соответствующей разделенной оплате
subMerchantId long Нет ID связанного с разделенной оплатой суб-торговца
subMerchantName string Да Присутствует ,если оплата была связана с суб-торговцем. Содержит название соответствующего суб-торговца
subMerchantPrice decimal Да Присутствует, если оплата была связана с суб-торговцем. Представляет собой долю общей суммы, которая будет перечислена суб-торговцу от общей суммы оплаты
subMerchantPayoutRate decimal Да Присутствует, если оплата была связана с суб-торговцем. Представляет собой отношение суммы, которая будет отправлена суб-торговцу, к сумме, отправленной для оплаты
subMerchantPayoutAmount decimal Да Присутствует, если оплата была связана с суб-торговцем. Представляет собой сумму, которая будет отправлена суб-торговцу в связи с оплатой
payout Payout Да (см.: Распределение отправки денег разделенной оплаты) Содержит информацию о распределении сумм отправки денег, между торговцем, суб-торговцем и Odero
paymentTransactionCard PaymentTransactionCard Да (см.: Информация о карте и комиссионном сборе разделенной оплаты) Содержит информацию о карте и комиссионном сборе, связанных с разделенной оплатой
paymentTransactionRefunds PaymentTransactionRefund[] Да (см.: Информация о возврате денег области оплаты) Содержит список полной или частичной информации о возврате денег, связанной с разделенной <оплатой>

Информация о карте и комиссии по Разделению Оплаты

Здесь содержатся сведения о карте и комиссионных сборах, связанных с разделением оплаты.

Название параметра Тип Всегда присутствует Описание
merchantCommissionRate decimal Да Ставка комиссии, применяемая торговцем к платежу
merchantCommissionRateAmount decimal Да Сумма комиссии торговца
pfCommissionRateAmount decimal Да Сумма комиссии Odero

Распределение Средств за Перевод Денег в Рамках Оплаты

Здесь содержится информация о распределении средств между торговцем, суб-торговцем и Odero, касающаяся выполнения денежного перевода, связанного с оплатой.

Валютой распределения всегда является AZN, поэтому при платежах в других валютах возникает разница в курсе. Эти различия указаны в полях pfConversionRate и pfConversionRateAmount.

Название параметра Тип Всегда присутствует Описание
paidPrice decimal Да Доля соответствующей суммы, удержанной для оплаты
currency Currency Да См.: Валюты
merchantPayoutAmount decimal Да Доля суммы, отправляемой торговцу в связи с разделенной оплатой
subMerchantPayoutAmount decimal Да Доля суммы, отправляемой суб-торговцу в связи с разделенной оплатой
pfCommissionRateAmount decimal Да Доля суммы, отправляемой Odero в качестве комиссии за оплату
pfConversionRate decimal Да Разница в обменных курсах, которую использует Odero при переводах в других валютах, отличных от AZN. Для платежей в AZN равно 0
pfConversionRateAmount decimal Да Разница в обменных курсах, которую Odero получает при переводах в других валютах, отличных от AZN. Для платежей в AZN равно 0

Информация о возврате, связанная с распределением платежей

Информация о полностью или частично успешных или неуспешных возвратах средств, связанных с распределением платежей.

Название параметра Тип Всегда присутствует Описание
id long Да ID, созданный Odero для операции возврата
createdDate date Да Дата создания операции возврата
refundStatus string Да см.: Статусы возврата
refundDestinationType RefundDestinationType Да см.: Типы возврата
price decimal Да Сумма возвращенного платежа
refundBankPrice decimal Да Возвращенная на банковскую карту после возврата
refundWalletPrice decimal Да Возвращенная на кошелек после возврата
conversationId string Да Значение conversationId, отправленное торговцем в запросе на возврат
paymentType PaymentType Да (см.: Типы платежей) Тип отмененного платежа
isAfterSettlement boolean Да Определяет, был ли возврат выполнен после отправки денег торговцу
error Error Нет (см.: Информация об ошибке) Присутствует в случае неудачного возврата. Содержит информацию об ошибке

Информация об ошибке

Содержит детали ошибки, полученные от банка во время проведения операции по возврату платежа. Значения errorCode и errorGroup соответствуют тем, которые представлены на странице Коды ошибок

Название параметра Тип Всегда присутствует Описание
errorCode string Да Значение errorCode, определенное Odero API для соответствующей ошибки
errorGroup string Да Группа ошибок
errorName string Нет Название ошибки, возвращенное банком
errorMessage string Нет Сообщение об ошибке, возвращенное банком