Skip to main content
GET
Export payouts

Authorizations

x-api-key
string
header
required

To get your own API keys, go to the Integration tab in your Rocka Hub.

Query Parameters

dateFrom
string<date-time>

Only include payouts that were made after a certain date. YYYY-MM-DD.

dateTo
string<date-time>

Only include payouts that were made before a certain date. YYYY-MM-DD.

status
enum<string>

Payout status.

Available options:
Processing,
Executing,
Failed,
Done,
Rejected

Response

200 - application/json

Payouts retrieved successfully.

id
string

Payout ID.

amount
number<double>

The total amount transferred.

currency
string

Payout currency.

status
string

Payout status.

fee
number<double>

Total payout fee.

balanceAfterOperation
number<double> | null

Balance remaining after the payout was completed.

balanceImpact
number<double>

The net change to the balance.

operationType
string

Transaction type.

createdAt
string<date-time>

The date and time the payout was created.

executedAt
string<date-time> | null

The date and time the payout was executed.

receivedAt
string<date-time> | null

The date and time the recipient received the payout.

rejectReason
string | null

The reason why the payout failed.

Last modified on August 21, 2026