Coach Payouts

This guide explains how to interact with the admin manage the coach payouts crud.

Get All Coach Payouts

Endpoint

• Method: GET
• URL: /v1/admin/coach-payouts

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Query Parameters

Parameter	Type	Description	Required	Default
search_text	string	Coach's name and email	No	null

Success Response

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
        "payouts": [
            {
                "id": "uuid",
                "coachName": "mohammed bamatraf",
                "email": "test60@test60.com",
                "payoutMethod": "PAYPAL",
                "balance": "600.00",
                "sessionsCount": 2,
                "coachPayoutsAmount": "0",
                "totalAmounts": "600.00",
                "lastPayoutAt": null,
                "lastPaidAt": null
            },
        ]
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Create Payout

Endpoint

• Method: POST
• URL: /v1/admin/coach-payout/pay

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
coach_id	string	Payout's coach id	Yes
sessions	array	Payout's sessions	Yes
payout_notes	string	Payout's payout notes	Yes

Success Response

{
    "success": true,
    "message": "OK",
    "data": {
        "payoutId": "uuid"
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Validation Error (422)

{
    "success": false,
    "message": "حدث خطأ في البيانات المرسلة يرجى التحقق منها.",
    "errors": {
        "sessions": "الجلسة a8e19200-1415-11f0-b2f9-395ba0ee4f8d لديها بالفعل معاملة دفع اخرئ , رقم المعامله 9eb02775-179c-45c0-ae38-ef0c7d919ed2"
    },
    "data": [],
    "statusCode": 422
}

Recheck Payout Status

Endpoint

• Method: GET
• URL: /v1/admin/coach-payout/{id}/recheck-payout-status

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Success Response

{
    "success": true,
    "message": "OK",
    "data": [],
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Cancel Payout

Endpoint

• Method: GET
• URL: /v1/admin/coach-payout/{id}/cancel-payout

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Success Response

{
    "success": true,
    "message": "يتم حاليا الغاء طلب الدفع و  إعادة الأموال الى محفظة المستشار",
    "data": [],
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Validation Error (422)

{
    "success": false,
    "message": "حالة الدفع اما مكتمله او مازالت في المعالجة ,يجب ان تكون الحالة Unclaimed",
    "errors": [
        "حالة الدفع اما مكتمله او مازالت في المعالجة ,يجب ان تكون الحالة Unclaimed"
    ],
    "data": [],
    "statusCode": 422
}

Refund Funds Coach Wallet

Endpoint

• Method: GET
• URL: /v1/admin/coach-payout/{id}/refund-funds-coach-wallet

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Success Response

{
    "success": true,
    "message": "OK",
    "data": [],
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Validation Error (422)

{
    "success": false,
    "message": "حالة الدفع اما مكتمله او مازالت في المعالجة او (مدفوعات لم يتم المطالبة بها)",
    "errors": [
        "حالة الدفع اما مكتمله او مازالت في المعالجة او (مدفوعات لم يتم المطالبة بها)"
    ],
    "data": [],
    "statusCode": 422
}

Export Coach Payouts

Endpoint

• Method: GET
• URL: /v1/admin/coach-payouts/export

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Query Parameters

Parameter	Type	Description	Required	Default
search_text	string	Coach's name and email	No	null

Success Response

Coaches Payouts Excel File.xlsx

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}