Тестирование веб-хуков

Тестовый платеж

post
https://api.cryptomus.com/v1/test-webhook/payment
копировать

Чтобы проверить подпись из массива данных webhook, используйте ключ платежного API.

Чтобы убедиться, что вы правильно получаете webhooks и можете подтвердить подпись, вам следует использовать этот метод для проверки webhooks на предмет оплаты.
Пожалуйста, обратите внимание, что никакие данные не сохраняются в базе данных, и любые данные, полученные в webhook, сохраняются в массиве только в целях тестирования, чтобы убедиться в правильности подписи и протестировать извлечение этого массива у нас.

Чтобы протестировать webhook с существующим счетом, пожалуйста, укажите его uuid или идентификатор заказа. Если эти параметры не указаны, webhook будет отправлен с тестовым счетом-фактурой.

Запрос

Параметры запроса

ИмяТип параметраЗначение по умолчаниюОписание
url_callback*stringmin:6max:150urlURL, на который будут отправлены веб-ссылки со статусом оплаты
currency*stringКод валюты счета-фактуры
network*stringСетевой код счета-фактуры
uuidstringuuidслучайная строка uuiduuid счета-фактуры
order_idstringmin:1max:32alpha_dashслучайная строкаИдентификатор заказа в счете-фактуре
status*stringpaidСтатус платежаДоступные опции:• process• check• paid• paid_over• fail• wrong_amount• cancel• system_fail• refund_process• refund_fail• refund_paid

Тип параметра

stringmin:6max:150url

Описание

URL, на который будут отправлены веб-ссылки со статусом оплаты

Тип параметра

string

Описание

Код валюты счета-фактуры

Тип параметра

string

Описание

Сетевой код счета-фактуры

Тип параметра

stringuuid

Описание

uuid счета-фактуры

Тип параметра

stringmin:1max:32alpha_dash

Описание

Идентификатор заказа в счете-фактуре

Тип параметра

string

Описание

Статус платежаДоступные опции:- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid

* - обязательный параметр

Вы можете передать один из параметров uuid или order_id, если вы передадите оба, учетная запись будет идентифицирована по uuid

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


curl https://api.cryptomus.com/v1/test-webhook/payment \
-X POST \
-H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'
копировать

Ответ

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


1{
2  "state": 0,
3  "result": []
4}
копировать

Тестовая выплата

post
https://api.cryptomus.com/v1/test-webhook/payout
копировать

Чтобы проверить подпись из массива данных webhook, используйте ключ платежного API.

Запрос

Параметры запроса

ИмяТип параметраЗначение по умолчаниюОписание
url_callback*stringmin:6max:150urlURL, на который будут отправлены веб-ссылки со статусом оплаты
currency*stringКод валюты выплаты
network*stringКод платежной сети
uuidstringuuidслучайная строка uuiduuid выплаты
order_idstringmin:1max:32alpha_dashслучайная строкаИдентификатор заказа на выплату
status*stringpaidСтатус выплатыДоступные опции:• process• check• paid• fail• cancel• system_fail

Тип параметра

stringmin:6max:150url

Описание

URL, на который будут отправлены веб-ссылки со статусом оплаты

Тип параметра

string

Описание

Код валюты выплаты

Тип параметра

string

Описание

Код платежной сети

Тип параметра

stringuuid

Описание

uuid выплаты

Тип параметра

stringmin:1max:32alpha_dash

Описание

Идентификатор заказа на выплату

Тип параметра

string

Описание

Статус выплатыДоступные опции:- process- check- paid- fail- cancel- system_fail

* - обязательный параметр

Вы можете передать один из параметров uuid или order_id, если вы передадите оба, учетная запись будет идентифицирована по uuid

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


curl https://api.cryptomus.com/v1/test-webhook/payout \
-X POST -H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'
копировать

Ответ

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


1{
2  "state": 0,
3  "result": []
4}
копировать

Тестовый кошелек

post
https://api.cryptomus.com/v1/test-webhook/wallet
копировать

Чтобы проверить подпись из массива данных webhook, используйте ключ платежного API.

Запрос

Параметры запроса

ИмяТип параметраЗначение по умолчаниюОписание
url_callback*stringmin:6max:150urlURL, на который будут отправлены веб-ссылки со статусом оплаты
currency*stringКод валюты платежа
network*stringКод платежной сети
uuidstringuuidслучайная строка uuiduuid бизнес-кошелька
order_idstringmin:1max:32alpha_dashслучайная строкаИдентификатор заказа в счете-фактуре
status*stringpaidСтатус платежаДоступные опции:• process• check• paid• paid_over• fail• wrong_amount• cancel• system_fail• refund_process• refund_fail• refund_paid

Тип параметра

stringmin:6max:150url

Описание

URL, на который будут отправлены веб-ссылки со статусом оплаты

Тип параметра

string

Описание

Код валюты платежа

Тип параметра

string

Описание

Код платежной сети

Тип параметра

stringuuid

Описание

uuid бизнес-кошелька

Тип параметра

stringmin:1max:32alpha_dash

Описание

Идентификатор заказа в счете-фактуре

Тип параметра

string

Описание

Статус платежаДоступные опции:- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid

* - обязательный параметр

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


curl https://api.cryptomus.com/v1/test-webhook/wallet \
-X POST -H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'
копировать

Ответ

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


1{
2  "state": 0,
3  "result": []
4}
копировать

Возможные ошибки

Ошибки проверки

код : 422

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

Если вы передаете uuid или order_id и счет-фактура/статический кошелек/выплата не найдены:


1{
2    "state": 1,
3    "message": "Not found payment"
4}
копировать


1{
2    "state": 1,
3    "message": "Not found payout"
4}
копировать


1{
2    "state": 1,
3    "message": "Not found wallet"
4}
копировать

Если вы не передадите требуемые параметры:


1{
2	"state": 1,
3	"errors": {
4		"currency": ["validation.required"]
5	}
6}
копировать

Если предоставленная валюта и сеть не являются криптографическими или не поддерживаются:


1{
2    "state": 1,
3    "message": "Payment service not found"
4}
копировать


1{
2    "state": 1,
3    "message": "Payout service not found"
4}
копировать