Утверждение распределения платежей
URL
Ниже приведена информация о конечной точке и http-методе, используемом для подтверждения разделения платежа:
| HTTP Metod | URL |
|---|---|
POST |
/payment/v1/payment-transactions/approve |
Параметры запроса
Параметры, которые, как ожидается, будут отправлены в запросах на подтверждение распределения платежей, перечислены в таблице и подзаголовках ниже.
| Название параметра | Тип | Обязательный | Описание |
|---|---|---|---|
paymentTransactionIds |
number[] |
Да | Содержит значения идентификаторов платежных разделений, требующих утверждения. |
isTransactional |
boolean |
Нет | Если это значение равно true, распределение платежей не утверждается во время операции подтверждения, если какое-либо распределение платежей не утверждено по процедурным причинам. Если это значение равно false, проверяемые распределения платежей утверждаются, а те, которые не подтверждены, остаются непроверенными. |
Возвращаемые параметры
Параметры, возвращаемые в результате процесса платежной транзакции, также подчиняются правилам, указанным в разделе Форматы возврата на главной странице документации API. При отсутствии систематической или структурной ошибки подпараметрами объекта, возвращаемыми в параметре data, являются:
| Название параметра | Тип | Обязательный | Описание |
|---|---|---|---|
size |
number |
Да | Количество распределений платежей, на которые влияет операция проверки. |
items |
PaymentTransactionApproval[] |
Да | Содержит объект, несущий информацию о транзакции утверждения. См .: Информация об утверждении разделенной оплаты |
paymentTransactions |
PaymentTransaction[] |
Да | См .: Информация об утвержденном разделении платежа |
Информация о подтверждении распределения платежей
Распределение платежей — это объект, который содержит информацию о транзакции и распределении платежей, выполненных в рамках объекта, возвращаемого во время запросов на подтверждение и вывод средств.
| Название параметра | Тип | Обязательный | Описание |
|---|---|---|---|
paymentTransactionId |
long |
Да | ID разделенного платежа |
approvalStatus |
string |
Да | Отображает значение SUCCESS, если результат разделенного платежа был успешным, и FAILURE, если неудачным |
failedReason |
string |
Да | Отображает информацию о деталях ошибки при ошибке утверждения или отмены утверждения разделенного платежа |
Отмена одобрения распределения платежей
URL
Ниже приведена информация о конечной точке и методе http, используемых для отмены подтверждения разделения платежа:
| HTTP Metod | URL |
|---|---|
POST |
/payment/v1/payment-transactions/disapprove |
Параметры запроса
Параметры, которые предполагается отправлять в запросах на отзыв подтверждения распределения платежей, перечислены под таблицей и подзаголовками ниже.
| Название параметра | Тип | Обязательный | Описание |
|---|---|---|---|
paymentTransactionIds |
number[] |
Да | Он содержит значения идентификаторов распределений платежей, которые хотят отменить ранее выданное подтверждение. |
isTransactional |
boolean |
Нет | Если это значение равно true, никакие утверждения распределения платежей не отменяются, если только какое-либо распределение платежей не отменяется по процедурным причинам во время операции подтверждения. Если это значение равно false, одобрение распределения отзывных платежей отменяется, а неутвержденные остаются неутвержденными. |
Параметры ответа
Параметры, возвращаемые в результате процесса оплаты, также подчиняются правилам, указанным в разделе Форматы возврата на главной странице документации API. При отсутствии систематической или структурной ошибки подпараметрами объекта, возвращаемыми в параметре data, являются:
| Название параметра | Тип | Обязательный | Описание |
|---|---|---|---|
size |
number |
Да | Количество распределений платежей, на которые влияет операция проверки. |
items |
PaymentTransactionApproval[] |
Да | См. объект, содержащий информацию о процессе подтверждения: Данные подтверждения Payment-Partition. |
paymentTransactions |
PaymentTransaction[] |
Да | см.: Подробности подтверждения распределения платежей |
Информация о подтверждении распределения платежей
Распределение платежей — это объект, который содержит информацию о транзакции и распределении платежей, выполненных в рамках объекта, возвращаемого во время запросов на подтверждение и вывод средств.
| Название параметра | Тип | Обязательный | Описание |
|---|---|---|---|
paymentTransactionId |
long |
Да | ID разделения оплаты |
approvalStatus |
string |
Да | Отображает значение SUCCESS, если результат разделения оплаты был успешным, и FAILURE, если неудачным |
failedReason |
string |
Да | Отображает информацию о деталях ошибки при ошибке утверждения или отмены утверждения разделения оплаты |
Обновление разделения оплаты
В случае необходимости изменения продавца или изменения цены продавца (бизнес-подразделение) в платежах за товары, вы можете обновить бизнес-подразделение и/или цену бизнес-подразделения. Для использования этой услуги вы должны быть бизнес-платформой и иметь продуктовый тип с оплатой.
Важные моменты
- Этот сервис может использоваться только платформами продаж.
- Этот сервис может использоваться только для успешных платежей.
- Группа оплаты может быть обновлена с разделениями оплаты, являющимися товарами.
- Сервис недоступен, когда статус отправки разделения оплаты равен
PAYOUT_STARTED(отправлено)илиPAYOUT_COMPLETED(отправлено). - Во время использования сервиса должны измениться как минимум одна из цен бизнес-подразделения или цена бизнес-подразделения.
- Платеж и разделение оплаты не должны быть отменены/возвращены ранее.
- Для аразделения оплаты вы можете внести столько обновлений, сколько вам нужно.
- Цена бизнес-подразделения не должна превышать цену разделения оплты.
- Статус электронного адреса оплаты должен быть в состоянии ожидания утверждения.
URL
Обновление платежного разделения
Информация о конечной точке и методе HTTP, используемых для обновления разделения оплаты, представлена ниже:
| HTTP Метод | URL | Параметры URL |
|---|---|---|
PUT |
/payment/v1/payment-transactions/:id |
id: Значение ID разделения оплаты |
Запрос параметров
Для отмены подтверждения разделения оплаты в запросах ожидаются следующие параметры, структурированные в таблице и подзаголовках:
| Имя параметра | Тип | Обязательный | Описание |
|---|---|---|---|
subMerchantId |
number |
Да | ID суб-торговца |
subMerchantPrice |
decimal |
Да | Цена суб-торговца |
Возврат параметров
В результате процесса обновления разделения оплаты возвращаемые параметры соответствуют правилам, указанным в разделе Форматы возврата на главной странице API. При отсутствии систематической или организационной ошибки, параметры возвращаемого объекта в параметре data следующие:
| Имя параметра | Тип | Всегда присутствует | Описание |
|---|---|---|---|
id |
long |
Да | ID разделения оплаты |
name |
string |
Нет | Имя, связанное с разделением оплаты, отправленное в запросе оплаты |
externalId |
string |
Нет | Внешний идентификатор, связанный с разделением оплаты, отправленный в запросе оплаты |
transactionStatus |
TransactionStatus |
Да | (см. Статусы отправки денег) Значение, обозначающее статус отправки денег в связи с разделением |
price |
decimal |
Да | Сумма разделения в корзине оплаты |
paidPrice |
decimal |
Да | Сумма, удержанная для оплаты, приведенная к соответствующему разделению |
walletPrice |
decimal |
Да | Сумма, удержанная из кошелька для оплаты, приведенная к соответствующему разделению |
merchantPayoutAmount |
decimal |
Да | Сумма, предназначенная для отправки торговцу, связанному с разделением |
subMerchantId |
long |
Нет | ID суб-торговца, связанного с разделением оплаты |
subMerchantPrice |
decimal |
Да | Присутствует, если разделение связано с суб-торговцем. Это доля суммы, которая будет передана суб-торговца от суммы оплаты, связанной с разделением |
subMerchantPayoutRate |
decimal |
Да | Процент, связанный с суб-торговцем. |
subMerchantPayoutAmount |
decimal |
Да | Присутствует, если разделение связано с суб-торговцем. Это представляет собой сумму, предназначенную для отправки суб-торговцу в связи с оплатой |
payout |
Payout |
Да | (см. Распределение отправки денег разделения оплаты) Здесь включено распределение сумм отправки денег, связанных с разделением, между бизнесом, связанным с разделением, подбизнесом и Odero |
Дополнительные актуальные операции распределения
| HTTP метод | URL | Описание |
|---|---|---|
POST |
/payment/v1/payment-transactions/approveWithUpdate |
Подтверждает распределение с обновлением subMerchantId и/или subMerchantPrice. |
POST |
/payment/v1/payment-transactions/reorganize |
Реорганизует до 250 распределений платежа. |
approveWithUpdate принимает обязательный paymentTransactionId, а также необязательные subMerchantId и положительный subMerchantPrice. reorganize принимает paymentId и непустой список items. Текущий ответ дополнительно содержит subExternalId, pointPrice, giftCardPrice, loyaltyPointPrice, withHoldingPrice и blockageResolvedDate.