Webhookのテスト

支払いのテスト

post
https://api.cryptomus.com/v1/test-webhook/payment
コピー

WebHookデータアレイの署名を検証するには、支払いAPIキーを使用します。

Webhookを正しく受信し、署名を検証できるようにするには、この方法を使用してWebhooksをテストする必要があります。
データベースに保存されるデータはありません。Webhookで受信したデータは、署名の正確性を確保し、この配列の取得をテストするためにテスト目的でのみ配列に保存されます。

既存の請求書でWebhookをテストするには、そのUUIDまたは注文IDを提供してください。これらのパラメーターが提供されていない場合、Webhookはテスト請求書で送信されます。

リクエスト

クエリパラメーター

名前パラメータータイプデフォルト値意味
url_callback*stringmin:6max:150url支払いステータスのWebhookが送信されるURL
currency*string請求書通貨コード
network*string請求書ネットワークコード
uuidstringuuidランダムUUID文字列請求書のuuid
order_idstringmin:1max:32alpha_dashランダムな文字列請求書の注文ID
status*stringpaid支払い状況利用可能なオプション：• process• check• paid• paid_over• fail• wrong_amount• cancel• system_fail• refund_process• refund_fail• refund_paid

パラメータータイプ

stringmin:6max:150url

意味

支払いステータスのWebhookが送信されるURL

パラメータータイプ

string

意味

請求書通貨コード

パラメータータイプ

string

意味

請求書ネットワークコード

パラメータータイプ

stringuuid

意味

請求書のuuid

パラメータータイプ

stringmin:1max:32alpha_dash

意味

請求書の注文ID

パラメータータイプ

string

意味

支払い状況利用可能なオプション：- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid

* - 必須パラメーター

uuidまたはorder_idパラメーターの1つを渡すことができます。両方を渡すと、アカウントは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支払いステータスのWebhookが送信されるURL
currency*string支払い通貨コード
network*stringペイアウトネットワークコード
uuidstringuuidランダムUUID文字列支払いのuuid
order_idstringmin:1max:32alpha_dashランダムな文字列支払いの注文ID
status*stringpaid支払いステータス利用可能なオプション：• process• check• paid• fail• cancel• system_fail

パラメータータイプ

stringmin:6max:150url

意味

支払いステータスのWebhookが送信されるURL

パラメータータイプ

string

意味

支払い通貨コード

パラメータータイプ

string

意味

ペイアウトネットワークコード

パラメータータイプ

stringuuid

意味

支払いのuuid

パラメータータイプ

stringmin:1max:32alpha_dash

意味

支払いの注文ID

パラメータータイプ

string

意味

支払いステータス利用可能なオプション：- process- check- paid- fail- cancel- system_fail

* - 必須パラメーター

uuidまたはorder_idパラメーターの1つを渡すことができます。両方を渡すと、アカウントは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支払いステータスのWebhookが送信されるURL
currency*string支払い通貨コード
network*string支払いネットワークコード
uuidstringuuidランダムUUID文字列ビジネスウォレットのuuid
order_idstringmin:1max:32alpha_dashランダムな文字列請求書の注文ID
status*stringpaid支払い状況利用可能なオプション：• process• check• paid• paid_over• fail• wrong_amount• cancel• system_fail• refund_process• refund_fail• refund_paid

パラメータータイプ

stringmin:6max:150url

意味

支払いステータスのWebhookが送信されるURL

パラメータータイプ

string

意味

支払い通貨コード

パラメータータイプ

string

意味

支払いネットワークコード

パラメータータイプ

stringuuid

意味

ビジネスウォレットのuuid

パラメータータイプ

stringmin:1max:32alpha_dash

意味

請求書の注文ID

パラメータータイプ

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}
コピー