get
https://cs-api.sandbox.paybis.com/v1/event/payout
Get a paginated list of payout events
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This endpoint retrieves a paginated list of all Payouts transactions associated with your account.
Overview
- History and Reporting: View a log of all past and current payouts.
- Reconciliation: Iterate through transactions to reconcile them with your internal records.
- Dashboard Display: Useful for showing a history of payouts in an admin panel or user interface.
Request
GET /v1/event/payout
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
Authorization | string | Header | Yes | Your API key. |
page | integer | Query | No | Current page number. Default: 1. Minimum: 1. Maximum: 100000. |
limit | integer | Query | No | Number of items per page. Default: 10. Minimum: 1. Maximum: 50. |
Response
200 OK
| Field | Type | Description |
|---|---|---|
status | string | API request status. |
result | object | Wrapper for the list and pagination data. |
result.pagination | object | Contains page, limit, and total count of payouts. |
result.items | array | List of payout events. |
result.items[].event_id | string | Event identifier. |
result.items[].status | string | State of the execute event. |
result.items[].payout | object or null | Payout details, with the same fields as result.payout in Get payout by event ID. null if the payout hasn't been created yet. |