Skip to main content
GET
/
api
/
payouts
Export payouts
curl --request GET \
  --url https://api.stage.rocka.live/api/payouts \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "amount": 123,
    "currency": "<string>",
    "fee": 123,
    "balanceAfterOperation": 123,
    "balanceImpact": 123,
    "operationType": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "executedAt": "2023-11-07T05:31:56Z",
    "receivedAt": "2023-11-07T05:31:56Z",
    "rejectReason": "<string>",
    "status": "<string>"
  }
]

Authorizations

​
x-api-key
string
header
required

To get your own API keys, go to the Integration tab in your Rocka Hub. Use your test (not live) credentials to make API requests from this form.

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
​
id
string
required

Payout ID.

​
amount
number<double>
required

The total amount that was transferred, in decimal format.

​
currency
string
required

Payout currency.

​
fee
number<double>
required

Total fees.

​
balanceAfterOperation
number<double> | null
required

Total balance remaining after this payout was completed.

​
balanceImpact
number<double>
required

The net change to the balance.

​
operationType
string
required

Transaction type.

​
createdAt
string<date-time>
required

The date and time the payout transaction was created.

​
executedAt
string<date-time>
required

The date and time the payout transaction was completed.

​
receivedAt
string<date-time>
required

The date and time the recipient received the payout.

​
rejectReason
string
required

The reason why the payout failed.

​
status
string

Payout status.