Aldy Pay
  1. Transaction
Aldy Pay
  • Vendors
    • Auth
      • Login With Password
      • Login Get Code
      • Login With Code
      • Send OTP
    • Transaction
      • Assets
        GET
      • Transactions
        POST
      • Invoice
        POST
      • Refund
        POST
  1. Transaction

Refund

POST
/api/v1/vendors/{vendor}/refund

Bad Request (Status Code: 400)#

در صورتی که دیتای ارسال با فرمت قابل قبول سرور همخوانی نداشته باشد. این خطا برگشت داده می شود.

Validation Data (Status Code: 422)#

در صورتی که دیتاهایی که نیاز به اعتبارسنجی دارند، نتواند اعتبار سنجی رو پاس کنند متن خطای مربوط به همان اعتبار سنجی در یک آرایه برگردانه میشود.
مثال:
"data": {
    "code": [
      "code انتخاب شده، معتبر نیست"
    ]
  }

NotFound (Status Code: 404)#

در صورتی که هیچ تراکنشی با دیتای ارسالی پیدا نشود خطای زیر برگشت داده می شود
پیام خطاتوضیح
تراکنشی با این مشخصات یافت نشدخطای پیدا نشدن تراکنش با دیتای ارسالی.

Invalid Data (Status Code: 422)#

در صورتی که هیچ تراکنشی با دیتای ارسالی پیدا نشود خطای زیر برگشت داده می شود
پیام خطاتوضیح
شعبه خریداری شده و شعبه مرجوعی یکسان نمیباشداطلاعات شعبه ارسا شده با شعبه تراکنش مرجع مطابقت ندارد
کارت مورد نظر غیر فعال میباشدکارت انتخابی در حال حاضر فعال نیست.
مقدار مرجوعی بیشتر از خرید میباشدمبلغ درخواستی با مبلغ کل تراکنش مطابقت ندارد

Internal Server Error (Status Code: 500)#

در صورت بروز خطای داخلی در سرور، پیام زیر بازگردانده می‌شود:
پیام خطاتوضیح
لطفاً مجدداً تلاش کنیدخطای داخلی سرور رخ داده است. لطفاً درخواست خود را بعداً تکرار کنید.

توضیحات:
تمامی پیام‌های خطا به‌صورت متنی و با فرمت JSON در پاسخ سرور بازگردانده می‌شوند.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠400Bad Request
🔴500Internal Server Error
🟠422Validation Error
🟠422Invalid Data
🟠404Transaction Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://devbo.aldypay.com/api/v1/vendors/aldypay/refund' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 1,
    "store_code": "WHM-1-1",
    "description": "test buy",
    "invoice_number":"951478369"
}'
Response Response Example
200 - Success
{
    "status": true,
    "code": 200,
    "description": "OK",
    "data": null
}
Modified at 2025-10-26 12:31:09
Previous
Invoice
Built with