Транзакции

Транзакции оплаты

Описание: Получение всех транзакций по получателям менеджера

Адрес: https://api.cloudtips.ru/api/transactions

Тип: GET

Запрос:

Наименование	Тип	Обязательность	Описание
dateFrom	String	Нет	Дата начала поиска транзакций
dateTo	String	Нет	Дата окончания посика транзакций
placeId	String	Нет	Поиск по уникальному идентификатору заведения
layoutId	String	Нет	Поиск по странице оплаты получателя
phoneNumber	String	Нет	Поиск по телефонному номеру получателя
transactionId	String	Нет	Поиск по уникальному идентификатору транзакции
status	String	Нет	Статус транзакции, значения: All, Success, WaitForConfirm, Need3ds, Canceled, Fail, Fail3ds
userId	String	Нет	Поиск по уникальному идентификатору получателя
page	Integer	Нет	Постраничный поиск
limit	Integer	Нет	Ограничение на количество записей

Пример запроса:

{
    "dateFrom": "string",
    "dateTo": "string",
    "placeId: "string",
    "layoutId: "string",
    "phoneNumer": "string",
    "transactonId": "string",
    "status": "string",
    "userId": "string",
    "page": 0,
    "limit": 0
}

Ответ:

Наименование	Тип	Обязательность	Описание
size	Integer	Да	Количество записей
totalAmount	Integer	Да	Общая сумма по полю amount
date	String	Да	Дата транзакции
amount	Integer	Да	Сумма транзакции
layoutId	String	Нет	Уникальный идентификатор страницы оплаты
paymentUrl	String	Нет	URL страницы оплаты
phoneNumber	String	Да	Телефон получателя
userId	String	Да	Уникальный идентификатор получателя
userEmail	String	Нет	Почта получателя
invoiceId	String	Нет	Внешний идентификатор
transactionId	Integer	Да	Уникальный идентификатор транзакции
currencyCode	String	Да	Код валюты транзакции
message	String	Нет	Тест ответа по операции
comment	String	Нет	Комментарий оставленный платящим
reasonCode	Integer	Да	Код ответа по операции
platform	String	Да	Как проводилась оплата
cardFirstSix	String	Нет	Первые 6 цифр карты платящего
cardLastFour	String	Нет	Последние 4 цифры карты платящего
cardType	String	Нет	Тип карты платящего
cardExpDate	String	Нет	Дата окончания действия карты платящего
cardTypeCode	String	Нет	Код типа карты платящего
issuerBankCountry	String	Нет	Страна эметента карты платящего
issuer	String	Нет	Эмитент карты платящего
status	String	Да	Статус транзакции: All, Success, WaitForConfirm, Need3ds, Canceled, Fail, Fail3ds
attemptsCount	Integer	Да	Количество попыток оплаты
updatedDate	String	Да	Дата обновления транзакции
placeId	String	Да	Уникальный идентификатор заведения
placeName	String	Да	Название заведения
payoutStatus	String	Да	Выплачена или нет
isAccumulatedPayout	Boolean	Да	В накоплении или нет
layoutTitle	String	Нет	Заголовок страницы оплаты
payerEmail	String	Нет	Почта платящего
payerPhoneNumber	String	Нет	Телефонный номер платящего
receiverName	String	Да	Имя получателя
payerName	String	Да	Имя платящего
rating		Нет	Компоненты рейтинга
score	Integer	Нет	Количество звезд
components		Нет	Категории рейтинга
id	String	Да	Уникальный идентификатор
title	String	Да	Название
selected	Boolean	Да	Выбрана или нет
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

Пример ответа:

{
  "data": {
    "size": 0,
    "totalAmount": 0,
    "items": [
      {
        "id": "string",
        "date": "2021-06-08T13:34:52.086Z",
        "amount": 0,
        "layoutId": "string",
        "paymentUrl": "string",
        "phoneNumber": "string",
        "userId": "string",
        "userEmail": "string",
        "invoiceId": "string",
        "transactionId": 0,
        "currencyCode": "string",
        "message": "string",
        "comment": "string",
        "reasonCode": 0,
        "platform": "string",
        "cardFirstSix": "string",
        "cardLastFour": "string",
        "cardType": "string",
        "cardExpDate": "string",
        "cardTypeCode": "string",
        "cardProduct": "string",
        "issuerBankCountry": "string",
        "issuer": "string",
        "status": 0,
        "attemptsCount": 0,
        "updatedDate": "2021-06-08T13:34:52.086Z",
        "placeId": "string",
        "placeName": "string",
        "payoutStatus": "string",
        "isAccumulatedPayout": true,
        "layoutTitle": "string",
        "payerEmail": "string",
        "payerPhoneNumber": "string",
        "receiverName": "string",
        "instantPayoutFee": 0,
        "payerName": "string",
        "rating": {
          "score": 0,
          "components": [
            {
              "id": "string",
              "title": "string",
              "selected": true
            }
          ]
        }
      }
    ]
  },
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Транзакции выплаты

Описание: Получение всех транзакций выплат получателям менеджера

Адрес: https://api.cloudtips.ru/api/payout

Тип: GET

Запрос:

Наименование	Тип	Обязательность	Описание
dateFrom	String	Нет	Дата начала поиска транзакций
dateTo	String	Нет	Дата окончания посика транзакций
phoneNumber	String	Нет	Поиск по телефонному номеру получателя
layoutId	String	Нет	Поиск по странице оплаты получателя
transactionId	long	Нет	Поиск по идентификатору транзакции
status	String	Нет	Статус транзакции, значения: All, Success, Fail
userId	String	Нет	Поиск по уникальному идентификатору получателя
page	Integer	Нет	Постраничный поиск
limit	Integer	Нет	Ограничение на количество записей

Пример запроса:

{
    "dateFrom": "string",
    "dateTo": "string",
    "phoneNumer": "string",
    "layoutId: "string",
    "id": "string",
    "payoutSttus": "string",
    "status": "string",
    "userId": "string",
    "page": 0,
    "limit": 0
}

Ответ:

Наименование	Тип	Обязательность	Описание
id	String	Да	Внутренний уникальный идентификатор транзакции
createdDate	String	Да	Дата транзакции
updatedDate	String	Да	Дата обновления транзакции
transactionId	Integer	Да	Уникальный идентификатор транзакции
paymentTransactionIds	Array of Integer	Да	Список транзакций оплаты входящих в выплату
transactionsAmount	Integer	Да	Сумма транзакции оплаты в выплате
payoutAmount	Integer	Да	Сумма к выплате
currencyCode	String	Да	Код валюты транзакции
cardFirstSix	String	Да	Первые 6 цифр карты получателя
cardLastFour	String	Да	Последние 4 цифры карты получателя
cardType	String	Да	Тип карты получателя
issuerCode	String	Да	Код эмитента
status	String	Да	Статус транзакции: All, Success, Fail
reasonCode	String	Да	Текст ответа по операции
cloudTipsFeeForReceiver	Integer	Да	Комиссия с платящего
message	String	Да	Код ответа по операции
userId	String	Да	Уникальный идентификатор получателя
email	String	Да	Почта получателя
phoneNumber	String	Да	Телефон получателя
layoutName	String	Да	Название страницы оплаты
layoutId	String	Да	Уникальный идентификатор страницы оплаты
totalCount	Integer	Да	Количество записей
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

Пример ответа:

{
  "data": {
    "items": [
      {
        "id": "string",
        "createdDate": "2021-06-08T14:35:36.168Z",
        "updatedDate": "2021-06-08T14:35:36.168Z",
        "transactionId": 0,
        "paymentTransactionIds": [
          0
        ],
        "transactionsAmount": 0,
        "payoutAmount": 0,
        "currencyCode": "string",
        "cardFirstSix": "string",
        "cardLastFour": "string",
        "cardType": "string",
        "issuerCode": "string",
        "status": "string",
        "reasonCode": "string",
        "cloudTipsFeeForReceiver": 0,
        "message": "string",
        "userId": "string",
        "email": "string",
        "phoneNumber": "string",
        "layoutName": "string",
        "layoutId": "string"
      }
    ],
    "totalCount": 0
  },
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}