Đền bù

post

https://api.cryptomus.com/v1/payment/refund

Sao chép

Lời yêu cầu

Tham số truy vấn

Tên	Kiểu tham số	Sự định nghĩa
address*	string	Địa chỉ để hoàn tiền
is_subtract*	boolean	Có nên lấy hoa hồng từ số dư của người bán hay từ số tiền hoàn lạiđúng - lấy hoa hồng từ số dư của người bánsai - giảm số tiền hoàn lại bằng số tiền hoa hồng
uuid*	uuidrequired_without: order_id	Hóa đơn uuid
order_id*	stringmin:1max:128alpha_dashrequired_without: uuid	ID đơn hàng hóa đơn

Kiểu tham số

string

Sự định nghĩa

Địa chỉ để hoàn tiền

Kiểu tham số

boolean

Sự định nghĩa

Có nên lấy hoa hồng từ số dư của người bán hay từ số tiền hoàn lạiđúng - lấy hoa hồng từ số dư của người bánsai - giảm số tiền hoàn lại bằng số tiền hoa hồng

Kiểu tham số

uuidrequired_without: order_id

Sự định nghĩa

Hóa đơn uuid

Kiểu tham số

stringmin:1max:128alpha_dashrequired_without: uuid

Sự định nghĩa

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

* - tham số bắt buộc

Hóa đơn được xác định bởi order_id hoặc uuid, nếu bạn vượt qua 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/payment/refund \
    -X POST \
    -H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
    -H 'sign: fe99035f86fa436181717b302b95bacff1' \
    -H 'Content-Type: application/json' \
    -d '{
            "uuid": "8b03432e-385b-4670-8d06-064591096795",
            "address": "TDD97yguPESTpcrJMqU6h2ozZbibv4Vaqm", 
            "is_subtract": "true"
        }'

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 hóa đơn có uuid hoặc order_id bạn cung cấp không tồn tại:


1{
2    "state": 1,
3    "message": "Payment was not found"
4}

Sao chép

Nếu bạn không truyền uuid và order_id, bạn sẽ nhận được thông báo này. Điều này có nghĩa là ít nhất một tham số là bắt buộc.


1{
2	"state": 1,
3	"errors": {
4		"uuid": ["validation.required_without"],
5		"order_id": ["validation.required_without"]
6	}
7}

Sao chép

Nếu giao dịch thanh toán bị chặn trên trang web của nhà cung cấp, bạn sẽ nhận được thông báo lỗi này. Ví dụ: điều này xảy ra khi bạn thay đổi mật khẩu và giao dịch thanh toán bị chặn trong 24 giờ.


1{
2    "state": 1,
3    "message": "You are forbidden"
4}
5

Sao chép

Nếu ví của người bán được kết nối với hóa đơn không tồn tại:


1{
2    "state": 1,
3    "message": "Undefined merchant wallet"
4}

Sao chép

Nếu hóa đơn chưa được hoàn tất hoặc chưa được thanh toán.


1{
2    "state": 1,
3    "message": "Refunds are made only for completed payments"
4}

Sao chép

Nếu số tiền cần hoàn lại vượt quá số tiền thanh toán hóa đơn:


1{
2    "state": 1,
3    "message": "The refund amount should not be more than the amount paid"
4}

Sao chép

Nếu xảy ra sự cố kỹ thuật và tạm thời không thể thanh toán, bạn có thể nhận được thông báo lỗi này:


1{
2    "state": 1,
3    "message": "Server error"
4}

Sao chép