Тестирование webhook-а

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

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

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

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

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

Запрос

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

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

: Тип параметра
stringmin:6max:150url
Описание
URL, на который будут отправляться webhooks с состоянием платежа
: Тип параметра
string
Описание
Код валюты счета-фактуры
: Тип параметра
string
Описание
Сетевой код счета-фактуры
: Тип параметра
stringuuid
Значение по умолчанию
случайная строка uuid
Описание
uuid счета-фактуры
: Тип параметра
stringmin:1max:32alpha_dash
Значение по умолчанию
случайная строка
Описание
Идентификатор заказа в счете-фактуре
: Тип параметра
string
Значение по умолчанию
paid
Описание
Статус платежаДоступные опции:- 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:150url	-	URL, на который будут отправляться webhooks с состоянием платежа
currency*	string	-	Код валюты выплаты
network*	string	-	Код платежной сети
uuid	stringuuid	случайная строка uuid	uuid выплаты
order_id	stringmin:1max:32alpha_dash	случайная строка	Идентификатор заказа на выплату
status*	string	paid	Статус выплатыДоступные опции:• process• check• paid• fail• cancel• system_fail

: Тип параметра
stringmin:6max:150url
Описание
URL, на который будут отправляться webhooks с состоянием платежа
: Тип параметра
string
Описание
Код валюты выплаты
: Тип параметра
string
Описание
Код платежной сети
: Тип параметра
stringuuid
Значение по умолчанию
случайная строка uuid
Описание
uuid выплаты
: Тип параметра
stringmin:1max:32alpha_dash
Значение по умолчанию
случайная строка
Описание
Идентификатор заказа на выплату
: Тип параметра
string
Значение по умолчанию
paid
Описание
Статус выплатыДоступные опции:- process- check- paid- fail- cancel- system_fail

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

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


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:150url	-	URL, на который будут отправляться webhooks с состоянием платежа
currency*	string	-	Код валюты платежа
network*	string	-	Код платежной сети
uuid	stringuuid	случайная строка uuid	uuid бизнес-кошелька
order_id	stringmin:1max:32alpha_dash	случайная строка	Идентификатор заказа в счете-фактуре
status*	string	paid	Статус платежаДоступные опции:• process• check• paid• paid_over• fail• wrong_amount• cancel• system_fail• refund_process• refund_fail• refund_paid

: Тип параметра
stringmin:6max:150url
Описание
URL, на который будут отправляться webhooks с состоянием платежа
: Тип параметра
string
Описание
Код валюты платежа
: Тип параметра
string
Описание
Код платежной сети
: Тип параметра
stringuuid
Значение по умолчанию
случайная строка uuid
Описание
uuid бизнес-кошелька
: Тип параметра
stringmin:1max:32alpha_dash
Значение по умолчанию
случайная строка
Описание
Идентификатор заказа в счете-фактуре
: Тип параметра
string
Значение по умолчанию
paid
Описание
Статус платежаДоступные опции:- 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}

Скопировать