بازپرداخت

post
https://api.cryptomus.com/v1/payment/refund
کپی

درخواست

پارامترهای پرس و جو

نامنوع پارامتریتعریف
address*stringآدرس که باید بازپرداخت شود
is_subtract*booleanاین که آیا کمیسیون از تعادل بازرگان یا از مبلغ بازپرداخت استفاده کنید true - کمیسیون را از تعادل بازرگان بگیرید false - مبلغ قابل استرداد را با مبلغ کمیسیون کاهش دهید
uuid*uuidrequired_without: order_idفاکتور uuid
order_id*stringmin:1max:128alpha_dashrequired_without: uuidشناسه سفارش فاکتور

نوع پارامتری

string

تعریف

آدرس که باید بازپرداخت شود

نوع پارامتری

boolean

تعریف

این که آیا کمیسیون از تعادل بازرگان یا از مبلغ بازپرداخت استفاده کنید true - کمیسیون را از تعادل بازرگان بگیرید false - مبلغ قابل استرداد را با مبلغ کمیسیون کاهش دهید

نوع پارامتری

uuidrequired_without: order_id

تعریف

فاکتور uuid

نوع پارامتری

stringmin:1max:128alpha_dashrequired_without: uuid

تعریف

شناسه سفارش فاکتور

* - پارامتر اجباری

فاکتور توسط مشخص می شود order_id یا uuid، اگر هر دو را تصویب کنید ، حساب توسط UUID مشخص می شود

مثال


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"
        }'
کپی

واکنش

نمونه پاسخ


1{
2  "state": 0,
3  "result": []
4}
کپی

خطاهای احتمالی

خطاهای اعتبار سنجی

رمز : 422

پاسخ های مثال:

اگر فاکتور با UUID یا order_id که ارائه کرده اید وجود ندارد:


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

اگر شما یک uuid و order_id را منتقل نکنید ، این پیام را دریافت خواهید کرد. این بدان معناست که حداقل یکی از پارامترها لازم است.


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

اگر پرداخت در بازرگان شما مسدود شود ، این پیام خطا را دریافت خواهید کرد. این اتفاق می افتد ، به عنوان مثال ، هنگامی که رمز عبور خود را تغییر می دهید و پرداخت ها به مدت 24 ساعت مسدود می شود.


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

اگر کیف پول بازرگان که به فاکتور وصل شده است وجود ندارد:


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

اگر فاکتور نهایی نشده یا پرداخت نشده است.


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

اگر مبلغ بازپرداخت بیش از مبلغ پرداخت فاکتور باشد:


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

اگر کار فنی رخ داد و پرداخت به طور موقت در دسترس نیست ، می توانید این پیام خطا را دریافت کنید:


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