Проведение оплаты

URL

Ниже представлена информация о конечной точке и http-методе, использованном для получения платежа:

HTTP Method URL
POST /payment/v1/card-payments

Параметры запроса для запуска платежа

Название параметра Тип Обязательный Объяснение
conversationId string Нет Значение "бумеранг", которое может быть отправлено с запросом и получено с ответом. Его можно использовать для связывания разных запросов друг с другом. Обычно используется номер заказа мерчанта, связанный с платежом.
price decimal Да Общая сумма платежа. Сумма товаров/услуг в корзине, должна быть равна этой сумме.
paidPrice decimal Да Общая сумма, которая заплатит клиент, рассчитывается с учётом таких разниц, как комиссионные и скидки. Платежи, которые полностью или частично собираются в кошельке и сумма, которая взимается с кошелька, включаются в эту сумму.
walletPrice decimal Нет Сумма, которая будет списана с кошелька покупателя, указанна в параметре buyerId. Обязательно при отправке платежей, которые будут полностью или частично списаны с кошелька.Он может быть отправлен как 0, при полной оплате с карты или при отсутствии buyerId. (Default: 0)
installment integer Да Количество платежей, из которых будет взиматься оплата. Его можно отправить как «1» для единичной оплаты. Возможные значения: 1, 2, 3, 6, 9 и 12.
buyerId long Нет ID покупателя, с которым связан платеж. Это относится к значению ID в системе Odero, а не к значению ID в собственной системе мерчанта.
currency Currency Да См. : Валюты Валюта, в которой будет произведена оплата.
paymentGroup PaymentGroup Да См. : Группы оплат
paymentPhase PaymentPhase Нет См.: Фазы оплат
card Card Нет (См. Информация о карте) Информация о карте по которой будет проведена оплата. Если оплата будет полностью произведена за счет средств кошелька (т.е paidPrice и walletPrice равны) , то данное поле необязательно
posAlias string Нет Используется для оплат TOKENGATE. Если поле заполнена , то оплата будет произведена через указаный POS (См.: Gateway оплаты)
items PaymentItem[] Да (см. : Информация о списке услуг) Информация о списке товаров. Должен быть отправлен хотя бы один элемент , а сумма отправленных элементов должна быть равна значению полю price .

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

Обязательно при полной или частичной оплате картой. Это могут быть данный Prepaid , Credit или Debit карты , также это может быть оплата заранее сохраненой картой.

Если поле cardUserKey в отправленных данных карты заполнено, то поля в разделе Информация сохраненной о карте действительны. А противном случае См. : Информация о Debit , Credit или Prepaid карте.

Информация о Debit , Credit или Prepaid карте

Название параметра Тип Обязательный Описание
cardHolderName string Да Имя/Фамилия держателя карты
cardNumber string Да Номер карты
expireYear string Да Год истечения срока карты
expireMonth string Да Месяц истечения срока карты
cvc string Да Защитный код карты
storeCardAfterSuccessPayment boolean Нет Если платеж прошел успешно, сохранить карту (Defolt: false)
cardAlias string Нет Имя, которое будет присвоено карте, если карта будет сохранена после успешной оплаты

Информация о сохраненной карте

Название параметра Тип Обязательный Описание
cardUserKey string Да Ключ сохраненной карты
cardToken string Да Код сохраненной карты

Информация о списке услуг

Все платежи должны быть отправлены одним или несколькими платежами. Сумма полей price отправленных элементов должна быть равна значению в поле price платежа.

Название параметра Тип Обязательный Описание
name string Да Название продукта или услуги, к которой относится платеж
price decimal Да Сумма в корзине соответствующего товара или услуги
externalId string Нет Значение внешнего идентификатора, представляющее соответствующий продукт или услугу. Обычно значение идентификатора этого раздела используется в бизнес-системе торговца.
subMerchantId long Нет Идентификатор суб-торговца, предоставляющей продукт или услугу.
subMerchantPrice decimal Нет Сумма, которая будет выделена из платежа суб-торговцу. Должно быть отправлено, если поле subMerchantId заполнено.

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

Параметры, возвращаемые в результате процесса платежной транзакции, также подчиняются правилам, указанным в разделе Форматы возврата главной страницы документации API.

Название параметра Тип Her Zaman Mevcut Описание
conversationId string Нет Значение conversationId, отправленное торговцем как часть запроса платежа.
id long Да ID платежа
createdDate date Да Дата проведения оплаты
price decimal Да Общая сумма платежа в корзине
paidPrice decimal Да Общая сумма сбора, уплаченная клиентом. в случае полной или частичной оплаты, взимаемой с кошелька, в эту сумму также включается сумма, подлежащая выводу с кошелька.
walletPrice decimal Да Сумма, снятая с кошелька
currency string Да Валюта платежа
buyerId long Нет Значение, указывающее идентификатор соответствующего участника в платежах, связанных с принимающим участником.
installment integer Да Количество платежей, которыми будет получена оплата. Возможные значения: 1, 2, 3, 6, 9 и 12.
paymentType PaymentType Да См. Типы оплат
paymentGroup PaymentGroup Да См. Группы оплат
paymentStatus PaymentStatus Да См. Статус оплат
paymentPhase PaymentPhase Да См. Фазы оплат
isThreeDS boolean Да Был ли платеж произведен с использованием 3D Secure
merchantCommissionRate decimal Да Ставка комиссии, применяемая к платежу торговца
merchantCommissionRateAmount decimal Да Общая сумма комиссии, полученной от платежа торговца.
pfCommissionRateAmount decimal Да Размер комиссии, полученной от платежа Odero как платежного посредника
cardUserKey string Нет Во время запроса для поля storeCardAfterSuccessPayment в поле информации о карте устанавливается значение true при отправленных платежах. Представляет собой сохраненный ключ зарегистрированной карты после успешной оплаты.
cardToken string Нет Во время запроса поле storeCardAfterSuccessPayment в поле информации о карте имеет значение true для отправленных платежей. Указывает сохраненный код карты, зарегистрированной после успешной оплаты
paidWithStoredCard boolean Да Указывает, производится ли оплата сохраненной картой
binNumber string Нет Появляется при оплате картой полностью или частями. Указывает первые 6 цифр номера карты.
lastFourDigits string Нет Появляется при оплате картой полностью или частями. Указывает последние 4 цифры номера карты.
cardType CardType Нет (См. Типы карт) Появляется при оплате картой полностью или частями. Указывает тип карты
cardAssociation CardAssociation Нет (См.: Ассоциации карт)Появляется при оплате картой полностью или частями. Указывает карточную организацию, выпустившую карту
cardBrand string Да Появляется при оплате картой полностью или частями.. Он имеет то же значение, что и cardBrand в сведениях о карте в запросе платежа.
paymentTransactions PaymentTransaction[] Да См.: Список оплаченных услуг

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

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

Название параметра Тип Всегда присутствует Описание
id long Да ID платежа
externalId string Нет Значение внешнего идентификатора, связанное с разделением платежа, отправленное в запросе платежа.
name string Да Название продукта или услуги, на которое ссылается разбивка платежа, отправленная в запросе платежа.
transactionStatus TransactionStatus Да См.: Статусы денежных переводов) Значение, указывающее статус передачи для распределения
price decimal Да Общая сумма платежа в корзине
paidPrice decimal Да Общая сумма сбора, уплаченная клиентом. в случае полной или частичной оплаты, взимаемой с кошелька, в эту сумму также включается сумма, подлежащая выводу с кошелька.
walletPrice decimal Да Сумма, снятая с кошелька
merchantCommissionRate decimal Да Ставка комиссии, применяемая к платежу предприятия-участника
merchantCommissionRateAmount decimal Да Общая сумма комиссии, полученной от платежа торговца. Он равен разнице между paidPrice и price
pfCommissionRateAmount decimal Да Размер комиссии, полученной TokenPay как платежного посредника
merchantPayoutAmount decimal Да Доля денег, которая будет отправлена торговцу в связи с выплатой, согласно соответствующему распределению.
subMerchantId long Нет Идентификатор суб-торговца, связанной с разделением платежей
subMerchantName string Да Разделение сборов происходит, когда суб-торговец связан с бизнесом. Содержит название соответствующей компании-участника.
subMerchantPrice decimal Да Разделение сборов происходит, когда суб-торговец связан с бизнесом. Это доля от общей суммы, подлежащая передаче суб-участнику бизнеса согласно соответствующему распределению.
subMerchantPayoutRate decimal Да Разделение сборов происходит, когда суб-торговец связан с бизнесом. Это соотношение денег, которые будут отправлены суб-торговцу, к деньгам, которые будут отправлены торговцу.
subMerchantPayoutAmount decimal Да Разделение сборов происходит, когда суб-торговец связан с бизнесом. Представляет собой сумму, которая будет отправлена суб-торговцу.
blockageResolvedDate date Да Дата истечения периода блокировки, необходимого для отправки денег.
payout Payout Да (см. Распределение денежных переводов) Сюда входит распределение сумм денежных переводов между торговцами, суб-торговцами и Odero в связи с распределение платежей

Распределение денежных переводов

Это включает в себя разделение доли платежного перевода между торговцами, суб-торговцами и Odero.

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

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