Тестування WebHook

Тестування платежу

post https://api.cryptomus.com/v1/test-webhook/payment Копія

Щоб підтвердити підпис із масиву даних Webhook, використовуйте ключ API платежу.

Щоб переконатися, що ви правильно отримуєте webhooks і можете перевірити підпис, слід використовувати цей метод для тестування webhooks для платежів.
Зверніть увагу, що дані не зберігаються в базі даних, і будь -які дані, отримані в Webhook, зберігаються лише в масиві для тестування, щоб забезпечити правильність підписів та перевірити пошук цього масиву від нас.

Щоб перевірити веб -кук із наявним рахунком -фактурою, надайте його UUID або ID замовити. Якщо ці параметри не будуть надані, WebHook буде надісланий з тестовою рахунком.

Прохання

Параметри запиту

НазваТип параметраЗначення за замовчуваннямВизначення
url_callback*stringmin:6max:150url-URL, на який будуть надсилатися webhooks зі статусом платежу
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, на який будуть надсилатися 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-Мережевий код виплат
uuidstringuuidВипадковий рядок UUIDuuid від виплат
order_idstringmin:1max:32alpha_dashвипадковий рядокЗамовлення ідентифікатора виплат
status*stringpaidСтатус виплатиДоступні варіанти:• 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

* - обов'язковий параметр

Ви можете передати один із параметрів 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:150url-URL, на який будуть надсилатися webhooks зі статусом платежу
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, на який будуть надсилатися 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}
Копія