Списания по токенам

Списания по токенам для сохранённых платёжных методов. Функция не доступна по умолчанию - уточняйте эту информацию у своего менеджера @tribute

Список платёжных токенов

get

Возвращает список сохранённых платёжных токенов для магазина. Требуется включённая функция tokenCharging.

Authorizations

Api-KeystringRequired

API ключ для аутентификации.

Query parameters

customerIdstringOptional

Фильтр по ID клиента

Example: user_12345

orderUuidstring · uuidOptional

Фильтр по UUID исходного заказа

Example: 550e8400-e29b-41d4-a716-446655440000

activestring · enumOptional

Фильтр по статусу активности (true - только активные токены)

Example: truePossible values:

limitinteger · min: 1 · max: 100Optional

Максимальное количество токенов (по умолчанию 50, максимум 100)

Default: 50Example: 50

offsetintegerOptional

Количество токенов для пропуска (пагинация)

Default: 0Example: 0

Responses

200

Успешный ответ

application/json

tokenstring · uuidRequired

UUID платёжного токена

Example: 550e8400-e29b-41d4-a716-446655440000

cardLast4stringRequired

Последние 4 цифры номера карты

Example: 1234

cardBrandstringOptional

Бренд карты (VISA, MASTERCARD и др.)

Example: VISA

customerIdstringOptional

Идентификатор клиента мерчанта (опционально)

Example: user_12345

amountinteger · int64Required

Фиксированная сумма списания в минимальных единицах валюты

Example: 100000

currencystring · enumRequired

Код валюты (в нижнем регистре)

Example: rubPossible values:

activebooleanRequired

Активен ли токен и может ли использоваться для списаний

Example: true

createdAtstring · date-timeRequired

Время создания токена в формате ISO 8601

Example: 2025-03-20T01:15:58Z

lastUsedAtstring · date-timeOptional

Время последнего списания по токену (опционально)

Example: 2025-03-25T12:30:00Z

401

Неавторизован (неверный API ключ)

application/json

403

Функция списания по токенам не включена для магазина

application/json

404

Магазин не найден

application/json

get

/shop/tokens

GET /api/v1/shop/tokens HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "token": "550e8400-e29b-41d4-a716-446655440000",
    "cardLast4": "1234",
    "cardBrand": "VISA",
    "customerId": "user_12345",
    "amount": 100000,
    "currency": "rub",
    "active": true,
    "createdAt": "2025-03-20T01:15:58Z",
    "lastUsedAt": "2025-03-25T12:30:00Z"
  }
]

Получить платёжный токен

get

Возвращает детали конкретного сохранённого платёжного токена. Требуется включённая функция tokenCharging.

Authorizations

Api-KeystringRequired

API ключ для аутентификации.

Path parameters

tokenstring · uuidRequired

UUID токена

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Успешный ответ

application/json

tokenstring · uuidRequired

UUID платёжного токена

Example: 550e8400-e29b-41d4-a716-446655440000

cardLast4stringRequired

Последние 4 цифры номера карты

Example: 1234

cardBrandstringOptional

Бренд карты (VISA, MASTERCARD и др.)

Example: VISA

customerIdstringOptional

Идентификатор клиента мерчанта (опционально)

Example: user_12345

amountinteger · int64Required

Фиксированная сумма списания в минимальных единицах валюты

Example: 100000

currencystring · enumRequired

Код валюты (в нижнем регистре)

Example: rubPossible values:

activebooleanRequired

Активен ли токен и может ли использоваться для списаний

Example: true

createdAtstring · date-timeRequired

Время создания токена в формате ISO 8601

Example: 2025-03-20T01:15:58Z

lastUsedAtstring · date-timeOptional

Время последнего списания по токену (опционально)

Example: 2025-03-25T12:30:00Z

401

Неавторизован (неверный API ключ)

application/json

403

Функция списания по токенам не включена для магазина

application/json

404

Токен или магазин не найден

application/json

get

/shop/tokens/{token}

GET /api/v1/shop/tokens/{token} HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "token": "550e8400-e29b-41d4-a716-446655440000",
  "cardLast4": "1234",
  "cardBrand": "VISA",
  "customerId": "user_12345",
  "amount": 100000,
  "currency": "rub",
  "active": true,
  "createdAt": "2025-03-20T01:15:58Z",
  "lastUsedAt": "2025-03-25T12:30:00Z"
}

Деактивировать платёжный токен

delete

Деактивирует сохранённый платёжный токен, предотвращая его использование для будущих списаний. Требуется включённая функция tokenCharging.

Authorizations

Api-KeystringRequired

API ключ для аутентификации.

Path parameters

tokenstring · uuidRequired

UUID токена

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Токен успешно деактивирован

application/json

successbooleanRequiredExample: true

messagestringRequiredExample: token deactivated

400

Некорректный запрос

application/json

401

Неавторизован (неверный API ключ)

application/json

403

Функция списания по токенам не включена для магазина

application/json

404

Токен или магазин не найден

application/json

delete

/shop/tokens/{token}

DELETE /api/v1/shop/tokens/{token} HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "token deactivated"
}

Создать списание

post

Создаёт новое списание по сохранённому платёжному токену, инициированное мерчантом. Мерчант указывает сумму списания в минимальных единицах валюты (центы/копейки). Требуется включённая функция tokenCharging.

Лимиты суммы (в минимальных единицах валюты):

EUR: 100 - 300 000 (€1 - €3 000)
RUB: 10 000 - 30 000 000 (₽100 - ₽300 000)
USD: 100 - 300 000 ($1 - $3 000)

Ограничение частоты:

1 минута между списаниями по одному токену (возвращает 429 с оставшимися секундами)
Только одно незавершённое списание на токен (возвращает 409)

Идемпотентность: Используйте параметр idempotencyKey для безопасного повтора запросов. Если списание с таким ключом уже существует, будет возвращено существующее списание.

Authorizations

Api-KeystringRequired

API ключ для аутентификации.

Body

tokenstring · uuidRequired

UUID платёжного токена для списания

Example: 550e8400-e29b-41d4-a716-446655440000

amountinteger · int64Required

Сумма списания в минимальных единицах валюты (центы/копейки)

Example: 100000

referencestring · max: 256Optional

Референс мерчанта для списания (опционально, макс. 256 символов)

Example: order-123

idempotencyKeystring · max: 64Optional

Уникальный ключ для предотвращения дублирования (опционально, макс. 64 символа)

Example: charge-req-abc123

Responses

200

Списание успешно создано

application/json

chargeUuidstring · uuidRequired

UUID списания

Example: 550e8400-e29b-41d4-a716-446655440000

statusstring · enumRequired

Статус списания

Example: processingPossible values:

referencestringOptional

Референс мерчанта (опционально)

Example: order-123

amountinteger · int64Required

Сумма списания в минимальных единицах валюты

Example: 100000

currencystring · enumRequired

Код валюты (в нижнем регистре)

Example: rubPossible values:

tokenstring · uuidOptional

UUID платёжного токена

Example: 550e8400-e29b-41d4-a716-446655440000

errorCodestringOptional

Код ошибки при неудачном списании (опционально)

Example: payment_declined

errorMessagestringOptional

Сообщение об ошибке при неудачном списании (опционально)

Example: Карта отклонена эмитентом

createdAtstring · date-timeRequired

Время создания списания в формате ISO 8601

Example: 2025-03-20T01:15:58Z

processedAtstring · date-timeOptional

Время завершения обработки списания (опционально)

Example: 2025-03-20T01:16:02Z

400

Некорректный запрос

application/json

401

Неавторизован (неверный API ключ)

application/json

403

Функция списания по токенам не включена для магазина

application/json

404

Токен или магазин не найден

application/json

409

Конфликт - списание уже в процессе

application/json

429

Превышен лимит запросов - необходимо подождать

application/json

502

Ошибка платёжного шлюза

application/json

post

/shop/charges

POST /api/v1/shop/charges HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "token": "550e8400-e29b-41d4-a716-446655440000",
  "amount": 100000,
  "reference": "order-123",
  "idempotencyKey": "charge-req-abc123"
}

{
  "chargeUuid": "550e8400-e29b-41d4-a716-446655440000",
  "status": "processing",
  "reference": "order-123",
  "amount": 100000,
  "currency": "rub",
  "token": "550e8400-e29b-41d4-a716-446655440000",
  "errorCode": "payment_declined",
  "errorMessage": "Карта отклонена эмитентом",
  "createdAt": "2025-03-20T01:15:58Z",
  "processedAt": "2025-03-20T01:16:02Z"
}

Получить списание

get

Возвращает статус и детали конкретного списания. Требуется включённая функция tokenCharging.

Authorizations

Api-KeystringRequired

API ключ для аутентификации.

Path parameters

chargeUuidstring · uuidRequired

UUID списания

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Успешный ответ

application/json

chargeUuidstring · uuidRequired

UUID списания

Example: 550e8400-e29b-41d4-a716-446655440000

statusstring · enumRequired

Статус списания

Example: processingPossible values:

referencestringOptional

Референс мерчанта (опционально)

Example: order-123

amountinteger · int64Required

Сумма списания в минимальных единицах валюты

Example: 100000

currencystring · enumRequired

Код валюты (в нижнем регистре)

Example: rubPossible values:

tokenstring · uuidOptional

UUID платёжного токена

Example: 550e8400-e29b-41d4-a716-446655440000

errorCodestringOptional

Код ошибки при неудачном списании (опционально)

Example: payment_declined

errorMessagestringOptional

Сообщение об ошибке при неудачном списании (опционально)

Example: Карта отклонена эмитентом

createdAtstring · date-timeRequired

Время создания списания в формате ISO 8601

Example: 2025-03-20T01:15:58Z

processedAtstring · date-timeOptional

Время завершения обработки списания (опционально)

Example: 2025-03-20T01:16:02Z

401

Неавторизован (неверный API ключ)

application/json

403

Функция списания по токенам не включена для магазина

application/json

404

Списание или магазин не найден

application/json

get

/shop/charges/{chargeUuid}

GET /api/v1/shop/charges/{chargeUuid} HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "chargeUuid": "550e8400-e29b-41d4-a716-446655440000",
  "status": "processing",
  "reference": "order-123",
  "amount": 100000,
  "currency": "rub",
  "token": "550e8400-e29b-41d4-a716-446655440000",
  "errorCode": "payment_declined",
  "errorMessage": "Карта отклонена эмитентом",
  "createdAt": "2025-03-20T01:15:58Z",
  "processedAt": "2025-03-20T01:16:02Z"
}

PreviousМетоды NextВебхуки

Last updated 2 days ago

hashtagСписок платёжных токенов

hashtagПолучить платёжный токен

hashtagДеактивировать платёжный токен

hashtagСоздать списание

hashtagПолучить списание

Список платёжных токенов

Получить платёжный токен

Деактивировать платёжный токен

Создать списание

Получить списание