Payouts

This guide explains the payouts of mentor calwe application.

Financial Commissions Info

Endpoint

• Method: GET
• URL: /v1/coach/payouts/financial-commissions-info

Request Headers

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

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "coachCommissionPercentageInSessionCompleted": 90,
        "coachCommissionPercentageInSessionNotCompleted": 10,
        "systemCommissionPercentageInSessionCompleted": 10,
        "systemCommissionPercentageInSessionNotCompleted": 90,
        "minimumTransfer": 5
    },
    "statusCode": 200
}

All Record Sessions Balance

Endpoint

• Method: GET
• URL: /v1/coach/payouts/record-session-balance-indexrecord-session-balance-index

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
status	string	Coach's payout status	No	null
duration	string	Session's duration	No	null
starts_at	string	Session's starts_at	No	null

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "sessions": [
            {
                "id": "f41b09e0-bde1-11ee-a226-bf58f9d63c65",
                "number": 2401000148,
                "totalPrice": "120.00",
                "duration": 60,
                "systemTaxAmount": "0.00",
                "systemProfitAmount": "12.00",
                "coachProfitAmount": "108.00",
                "startsAt": "2024-01-28T13:36:00.000000Z",
                "payoutStatus": "COMPLETED"
            },
        ]
    },
    "statusCode": 200
}

Export Record Sessions Balance

Endpoint

• Method: GET
• URL: /v1/coach/payouts/record-session-balance-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
status	string	Coach's payout status	No	null
duration	string	Session's duration	No	null
starts_at	string	Session's starts_at	No	null
ids	string	Session's selected ids	No	null

Success Response

Export Excel File

All Transactions

Endpoint

• Method: GET
• URL: /v1/coach/payouts/transactions

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 payout searching	No	null

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
         "payoutsTransactions": [
            {
                "id": "9b335c12-d05f-4741-b39d-ce41c7fbb170",
                "amount": "216.00",
                "sessionsCount": 2,
                "sessionsNumber": [
                    2401000121,
                    2401000101
                ],
                "paymentType": "STC",
                "status": "COMPLETED",
                "createdAt": "2024-01-28 16:35:03"
            },
        ]
    },
    "statusCode": 200
}

Export Transactions

Endpoint

• Method: GET
• URL: /v1/coach/payouts/transactions/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 payout searching	No	null
ids	string	Coach's payout selected ids	No	null

Success Response

Export Excel File