Kiểm tra webhook

Kiểm tra thanh toán

post https://api.cryptomus.com/v1/test-webhook/payment Sao chép

Để xác thực chữ ký từ mảng dữ liệu webhook, hãy sử dụng khóa API thanh toán.

Để đảm bảo rằng bạn đang nhận được webhooks chính xác và có thể xác thực chữ ký, bạn nên sử dụng phương pháp này để kiểm tra webhooks để thanh toán.
Xin lưu ý rằng không có dữ liệu nào được lưu vào cơ sở dữ liệu và bất kỳ dữ liệu nào nhận được trong webhook chỉ được lưu trữ trong một mảng cho mục đích thử nghiệm để đảm bảo tính chính xác của chữ ký và để kiểm tra việc truy xuất mảng này từ chúng tôi.

Để kiểm tra webhook với hóa đơn hiện có, vui lòng cung cấp uuid hoặc ID đơn hàng của hóa đơn đó. Nếu không cung cấp các thông số này, webhook sẽ được gửi kèm hóa đơn thử nghiệm.

Lời yêu cầu

Tham số truy vấn

TênKiểu tham sốGiá trị mặc địnhSự định nghĩa
url_callback*stringmin:6max:150url-URL mà webhooks có trạng thái thanh toán sẽ được gửi đến
currency*string-Mã tiền tệ hóa đơn
network*string-Mã mạng hóa đơn
uuidstringuuidchuỗi uuid ngẫu nhiênuuid của hóa đơn
order_idstringmin:1max:32alpha_dashchuỗi ngẫu nhiênID đơn hàng của hóa đơn
status*stringpaidTrạng thái thanh toánCác tùy chọn có sẵn:• process• check• paid• paid_over• fail• wrong_amount• cancel• system_fail• refund_process• refund_fail• refund_paid

Kiểu tham số

stringmin:6max:150url

Sự định nghĩa

URL mà webhooks có trạng thái thanh toán sẽ được gửi đến

Kiểu tham số

string

Sự định nghĩa

Mã tiền tệ hóa đơn

Kiểu tham số

string

Sự định nghĩa

Mã mạng hóa đơn

Kiểu tham số

stringuuid

Giá trị mặc định

chuỗi uuid ngẫu nhiên

Sự định nghĩa

uuid của hóa đơn

Kiểu tham số

stringmin:1max:32alpha_dash

Giá trị mặc định

chuỗi ngẫu nhiên

Sự định nghĩa

ID đơn hàng của hóa đơn

Kiểu tham số

string

Giá trị mặc định

paid

Sự định nghĩa

Trạng thái thanh toánCác tùy chọn có sẵn:- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid

* - tham số bắt buộc

Bạn có thể truyền một trong các tham số uuid hoặc order_id, nếu bạn truyền cả hai, tài khoản sẽ được xác định bằng uuid

Ví dụ yêu cầu


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"
}'
Sao chép

Phản ứng

Ví dụ phản hồi


1{
2  "state": 0,
3  "result": []
4}
Sao chép

Kiểm tra thanh toán

post https://api.cryptomus.com/v1/test-webhook/payout Sao chép

Để xác thực chữ ký từ mảng dữ liệu webhook, hãy sử dụng khóa API thanh toán.

Lời yêu cầu

Tham số truy vấn

TênKiểu tham sốGiá trị mặc địnhSự định nghĩa
url_callback*stringmin:6max:150url-URL mà webhooks có trạng thái thanh toán sẽ được gửi đến
currency*string-Mã tiền tệ thanh toán
network*string-Mã mạng thanh toán
uuidstringuuidchuỗi uuid ngẫu nhiênuuid của khoản thanh toán
order_idstringmin:1max:32alpha_dashchuỗi ngẫu nhiênID đơn hàng của khoản thanh toán
status*stringpaidTrạng thái thanh toánCác tùy chọn có sẵn:• process• check• paid• fail• cancel• system_fail

Kiểu tham số

stringmin:6max:150url

Sự định nghĩa

URL mà webhooks có trạng thái thanh toán sẽ được gửi đến

Kiểu tham số

string

Sự định nghĩa

Mã tiền tệ thanh toán

Kiểu tham số

string

Sự định nghĩa

Mã mạng thanh toán

Kiểu tham số

stringuuid

Giá trị mặc định

chuỗi uuid ngẫu nhiên

Sự định nghĩa

uuid của khoản thanh toán

Kiểu tham số

stringmin:1max:32alpha_dash

Giá trị mặc định

chuỗi ngẫu nhiên

Sự định nghĩa

ID đơn hàng của khoản thanh toán

Kiểu tham số

string

Giá trị mặc định

paid

Sự định nghĩa

Trạng thái thanh toánCác tùy chọn có sẵn:- process- check- paid- fail- cancel- system_fail

* - tham số bắt buộc

Bạn có thể truyền một trong các tham số uuid hoặc order_id, nếu bạn truyền cả hai, tài khoản sẽ được xác định bằng uuid

Ví dụ yêu cầu


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"
}'
Sao chép

Phản ứng

Ví dụ phản hồi


1{
2  "state": 0,
3  "result": []
4}
Sao chép

Kiểm tra ví

post https://api.cryptomus.com/v1/test-webhook/wallet Sao chép

Để xác thực chữ ký từ mảng dữ liệu webhook, hãy sử dụng khóa API thanh toán.

Lời yêu cầu

Tham số truy vấn

TênKiểu tham sốGiá trị mặc địnhSự định nghĩa
url_callback*stringmin:6max:150url-URL mà webhooks có trạng thái thanh toán sẽ được gửi đến
currency*string-Mã tiền tệ thanh toán
network*string-Mã mạng thanh toán
uuidstringuuidchuỗi uuid ngẫu nhiênuuid của ví doanh nghiệp
order_idstringmin:1max:32alpha_dashchuỗi ngẫu nhiênID đơn hàng của hóa đơn
status*stringpaidTrạng thái thanh toánCác tùy chọn có sẵn:• process• check• paid• paid_over• fail• wrong_amount• cancel• system_fail• refund_process• refund_fail• refund_paid

Kiểu tham số

stringmin:6max:150url

Sự định nghĩa

URL mà webhooks có trạng thái thanh toán sẽ được gửi đến

Kiểu tham số

string

Sự định nghĩa

Mã tiền tệ thanh toán

Kiểu tham số

string

Sự định nghĩa

Mã mạng thanh toán

Kiểu tham số

stringuuid

Giá trị mặc định

chuỗi uuid ngẫu nhiên

Sự định nghĩa

uuid của ví doanh nghiệp

Kiểu tham số

stringmin:1max:32alpha_dash

Giá trị mặc định

chuỗi ngẫu nhiên

Sự định nghĩa

ID đơn hàng của hóa đơn

Kiểu tham số

string

Giá trị mặc định

paid

Sự định nghĩa

Trạng thái thanh toánCác tùy chọn có sẵn:- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid

* - tham số bắt buộc

Ví dụ yêu cầu


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"
}'
Sao chép

Phản ứng

Ví dụ phản hồi


1{
2  "state": 0,
3  "result": []
4}
Sao chép

Lỗi có thể xảy ra

Lỗi xác thực

mã số : 422

ví dụ phản hồi:

Nếu bạn truyền uuid hoặc order_id và không tìm thấy hóa đơn/ví tĩnh/khoản thanh toán:


1{
2    "state": 1,
3    "message": "Not found payment"
4}
Sao chép


1{
2    "state": 1,
3    "message": "Not found payout"
4}
Sao chép


1{
2    "state": 1,
3    "message": "Not found wallet"
4}
Sao chép

Nếu bạn không truyền đủ các tham số bắt buộc:


1{
2	"state": 1,
3	"errors": {
4		"currency": ["validation.required"]
5	}
6}
Sao chép

Nếu loại tiền tệ và mạng được cung cấp không phải là tiền điện tử hoặc không được hỗ trợ:


1{
2    "state": 1,
3    "message": "Payment service not found"
4}
Sao chép


1{
2    "state": 1,
3    "message": "Payout service not found"
4}
Sao chép