VendorPayoutsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| getVendorPayout | GET /vendors/{vendor_id}/payouts/{payout_id} | Retrieve details of a specific vendor payout |
| listVendorPayouts | GET /vendors/{vendor_id}/payouts | Retrieve all payouts for a vendor |
| requestVendorPayout | POST /vendors/{vendor_id}/payouts | Request a payout for vendor earnings |
getVendorPayout
PayoutResponse getVendorPayout(vendor_id, payout_id)
Retrieve details of a specific vendor payout
Returns detailed information about a single payout transaction including its current status, amount, and processing timestamps for the specified vendor.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor who owns the payout | [default to null] |
| payout_id | Long | Unique identifier of the payout to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listVendorPayouts
PaginatedResponse_PayoutResponse listVendorPayouts(vendor_id, page, per_page)
Retrieve all payouts for a vendor
Returns a complete list of all payout transactions for the specified vendor, including pending, completed, and failed payouts with their respective amounts and timestamps.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor whose payouts to retrieve | [default to null] |
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Number of items per page (default: 20) | [optional] [default to null] |
Return type
PaginatedResponse_PayoutResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
requestVendorPayout
PayoutResponse requestVendorPayout(vendor_id, VendorPayoutInput)
Request a payout for vendor earnings
Creates a new payout request to transfer available vendor earnings to the specified payment account. The payout amount must not exceed the vendor’s current available balance.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor requesting the payout | [default to null] |
| VendorPayoutInput | VendorPayoutInput | Payout request details including amount and payment account |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8