Versions Compared

Version Old Version 5 New Version 6
Changes made by

Anton Sukhorukov

Anton Sukhorukov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Адрес: https://api.cloudtips.ru/api/cards?userId={userId}, где userId - уникальный идентификатор получателя

Тип: GET

Ответ:

Наименование

Тип

Обязательность

Описание

cardFirstSix

String

Да

Первые 6 цифр карты получателя

cardLastFour

String

Да

Последние 4 цифры карты получателя

cardType

String

Да

Тип карты

cardExpirationDate

String

Да

Дата окончания действия карты

issuerCode

String

Да

Эмитент карты

token

String

Да

Уникальный идентификатор карты в системе

isDefault

String

Да

Карта по умолчанию, значения true и false

commissionHint

String

Да

Информации о комиссии для текущей карты

succeed

String

Да

Стату запроса

errors

Array of string

Да

Возвращатеся список ошибок, относящихся целиком к запросу

validationErrors

Array of string

Да

Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

Code Block
{
  "data": [
    {
      "firstSix": "string",
      "lastFour": "string",
      "cardType": "string",
      "cardExpirationDate": "string",
      "issuerCode": "string",
      "token": "string",
      "isDefault": true,
      "commissionHint": "string"
    }
  ],
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

...

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

Тип: DELETE

Запрос:

Наименование

Тип

Обязательность

Описание

cardToken

String

Да

Уникальный идентификатор карты в системе

userId

String

Да

Уникальный идентификатор получателя в системе

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

Code Block
{
  "cardToken": "string",
  "userId": "string"
}

Ответ:

Наименование

Тип

Обязательность

Описание

succeed

String

Да

Стату запроса

errors

Array of string

Да

Возвращатеся список ошибок, относящихся целиком к запросу

validationErrors

Array of string

Да

Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

Code Block
{
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

...

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

Тип: POST

Запрос:

Наименование

Тип

Обязательность

Описание

cardToken

String

Да

Уникальный идентификатор карты в системе

userId

String

Да

Уникальный идентификатор получателя в системе

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

Code Block
{
  "cardToken": "string",
  "userId": "string"
}

Ответ:

Наименование

Тип

Обязательность

Описание

succeed

String

Да

Стату запроса

errors

Array of string

Да

Возвращатеся список ошибок, относящихся целиком к запросу

validationErrors

Array of string

Да

Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

Code Block
{
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Получение publicId для привязки карты​

Описание: Позволяет получить publicId для формирования криптограммы

Адрес: https://api.cloudtips.ru/api​/cards​/{userId}/publicid

Тип: GET

Запрос:

Наименование

Тип

Обязательность

Описание

userId

String

Да

Идентификатор юзера

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

Code Block
https://api.cloudtips.ru/api​/cards​/80eb050b-77c7-475c-ba98-70cf45f0003c/publicid

Ответ:

Наименование

Тип

Обязательность

Описание

Наименование

Тип

Обязательность

Описание

publicId

String

Да

Уникальный идентификатор терминала

succeed

Boolean

Да

Стату запроса, значение true и false

errors

Array of string

Да

Возвращатеся список ошибок, относящихся целиком к запросу

validationErrors

Array of string

Да

Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

Code Block
languagejson
{
  "data": {
    "publicId": "string"
  },
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ]
  }
}