استرداد

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}
ينسخ