Що таке Мерчант API

Мерчант API — це платіжний API застосунку для бізнесу та ботів. Ви створюєте застосунок, отримуєте API-токен і з його допомогою виставляєте рахунки користувачам Telegram, надсилаєте їм виплати та перевіряєте баланс — усе з власного коду.

Це той самий продукт, але з боку розробника: рахунок, створений через API, — той самий рахунок, який користувач оплачує зі свого балансу одним дотиком.

Що з ним можна робити

• Рахунки — створіть запит на оплату (фіксована сума в криптовалюті, ціна у фіаті або вільна сума, яку вводить платник), надішліть платнику посилання й отримайте підписаний вебхук у момент оплати.
• Повернення — поверніть суму оплаченого рахунка, повністю або частково, тому, хто платив, — включно з анонімними платниками.
• Перекази — надсилайте криптовалюту з балансу застосунку користувачу Telegram: по одному або до 100 за один виклик.
• Чеки — випускайте з балансу застосунку посилання, які може активувати будь-хто.
• Підписки — регулярні платежі: користувач один раз підтверджує план, а далі списання відбувається автоматично кожного періоду.
• Баланси, валюти, курси обміну та статистика — методи лише для читання, для вашого власного обліку.

Як усе влаштовано

1. Ваш застосунок має власний баланс, окремий від вашого особистого гаманця.
2. Рахунки, оплачені користувачами, зараховуються на баланс застосунку.
3. Перекази та чеки списуються з нього.
4. Кожна важлива подія може надходити на ваш сервер підписаним вебхуком.

Платежі виконуються всередині застосунку, а не в блокчейні: без комісії мережі, без очікування підтверджень, а кошти можна використовувати одразу після надходження. Платник усе одно може оплатити рахунок із зовнішнього гаманця — його переказ надходить у його власний гаманець, і рахунок оплачується з нього автоматично; з вашого боку це виглядає так само, як будь-який інший оплачений рахунок.

Сумісність із Crypto Bot

API навмисно повторює Crypto Bot: ті самі назви методів, той самий конверт {ok, result}, ті самі суми десятковими рядками, та сама схема підпису вебхуків. Наявну інтеграцію з Crypto Bot можна спрямувати на нас, змінивши базовий URL і токен, — форми запитів і відповідей не змінюються.

Канонічний заголовок токена — TgCryptoPay-API-Token; Crypto-Pay-API-Token приймається як псевдонім, щоб наявні клієнтські бібліотеки працювали без змін.

⚠️ API-токен відкриває доступ до коштів застосунку

Будь-хто, у кого він є, може вивести баланс вашого застосунку. Тримайте токен на сервері, поза клієнтськими застосунками та репозиторіями, і оновіть його, щойно запідозрите витік. Серверам, яким не потрібен повний доступ, випустіть обмежений токен лише з тими правами, які вони справді використовують, — див. довідник API.

Далі

• Як почати роботу з API
• Приймання платежів через рахунки
• Довідник Мерчант API