Поиск платежа

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

URL

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

HTTP Method URL URL параметры
GET /payment-reporting/v1/payments Смотрите для параметров URL. Параметры URL для поиска платежа

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

Все параметры в запросе на поиск являются необязательными. Если какой-либо параметр не отправлен, он не учитывается в параметрах поиска. Если хотя бы один из параметров, прямо указывающих на платеж, таких как paymentIds, paymentTransactionIds и conversationId, заполнен, параметры minCreatedDate и maxCreatedDate не учитываются.

Имя параметра Тип Обязательный Описание
page integer Нет Номер страницы требуемых результатов поиска (По умолчанию: 0)
size integer Нет Количество результатов на странице для возврата по результатам запроса (По умолчанию: 10)
paymentIds long[] Нет Идентификаторы платежей, разделенные запятыми.
paymentTransactionIds long[] Нет ID транзакций платежа
subMerchantIds long[] Нет ID суб-торговцев, связанных с платежом
itemExternalIds string[] Нет Внешние ID частей платежа
paymentStatus PaymentStatus Нет (см. Статусы платежей) Статус платежа
currency Currency Нет (см. Валюты) Валюта платежа
binNumber string Нет Первые 6 цифр номера карты
lastFourDigits string Нет Последние 4 цифры номера карты
connectorType ConnectorType Нет Тип коннектора. Для платежей через TOKENGATE это значение будет TOKENGATE, для платежей через TOKENPOS - TOKENPOS. см. Платежи через шлюз
minPrice decimal Нет Минимальная сумма корзины
maxPrice decimal Нет Максимальная сумма корзины
maxPaidPrice decimal Нет Минимальная удерживаемая общая сумма
minPaidPrice decimal Нет Максимальная удерживаемая общая сумма
installment integer Нет Количество выплат для оплаты. Возможные значения: 1, 2, 3, 6, 9 и 12
conversationId string Нет Значение conversationId, отправленное торговцем в запросе на оплату
isThreeDS boolean Нет Была ли оплата проведена с 3D Secure
minCreatedDate date Нет Минимальная дата платежа. Не учитывается, если хотя бы один из параметров paymentIds, paymentTransactionIds или conversationId верен
maxCreatedDate date Нет Максимальная дата платежа. Не учитывается, если хотя бы один из параметров paymentIds, paymentTransactionIds или conversationId верен

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

Параметры, возвращаемые в процессе платежа, подчиняются правилам, указанным в разделе Форматы возврата на основной странице документации API. Если система или организация не обнаруживает ошибок, ответ будет представлен в виде эффективного многостраничного ответа (см. Многостраничные операции). Поля, входящие в объекты в списке items возвращенного ответа, приведены в таблице ниже:

Имя параметра Тип Обязательно Описание
id long Да ID платежа
createdDate date Да Дата создания платежа
updatedDate date Да Дата обновления платежа
orderId string Да Уникальный идентификатор, созданный относительно платежа
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 Нет (смотрите: Информация об ошибке) Присутствует в случае неудачного возврата. Содержит информацию об ошибке

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

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

>(смотрите: Распределение денег при разделении платежа) Содержит данные о суммах, связанных с отправкой денег при разделении платежа между торговцем, суб-торговцем и Odero >(смотрите: Информация о карте и комиссии при разделении платежа) Содержит информацию о карте и комиссии, связанных с разделением платежа >(смотрите: Информация о возвратах при разделении платежа) Список полной или частичной информации о возврате денег, связанной с разделением платежа
Имя параметра Тип Всегда присутствует Описание
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 Да
paymentTransactionCard PaymentTransactionCard Да
paymentTransactionRefunds PaymentTransactionRefund[] Да

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

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

Имя параметра Тип Всегда присутствует Описание
merchantCommissionRate decimal Да Процент комиссии, применяемый к платежу торговцем
merchantCommissionRateAmount decimal Да Доля суммы комиссии, полученной торговцем от платежа
pfCommissionRateAmount decimal Да Доля суммы комиссии, полученной Odero в качестве платежного посредника

Распределение денег при разделении платежа

Содержит информацию о распределении средств при платежах между торговцем, суб-торговцем и Odero.

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

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