Create a payout

curl --request POST \ --url https://api.stage.rocka.live/api/payouts \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data ' { "amount": 50, "currency": "EUR", "iban": "DE75512108001245126199", "beneficiaryName": "Mark Schmidt", "webhookUrl": "https://example.com/webhookUrl", "requestId": "payout1794" } '

{ "iban": "DE75512108001245126199", "beneficiaryName": "Mark Schmidt", "beneficiaryRef": "BC83DF4B0A634 OU", "id": "e01186ef9a1442afb924a8ad60d24390", "status": "Processing", "createdAt": "2026-05-08T11:26:10.455Z", "amount": 50, "currency": "EUR", "requestId": "payout1794" }

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.

Body

application/json

Data needed to create a new payout

amount

number<decimal>

required

The total amount to be transferred, in decimal format.

requestId

string

required

The payout's unique identifier (to prevent duplicate requests).

currency

string

required

Payment currency. Currently accepted: EUR.

iban

string

required

Recipient's IBAN (International Bank Account Number).

beneficiaryName

string

required

Recipient's full name.

webhookUrl

string

required

The URL that'll be used to fetch payout status updates.

Response

string

required

This payout's unique ID in Rocka's records.

amount

number<decimal>

required

Payout amount.

currency

string

required

Payout currency.

createdAt

string

required

Date and time when the payout was registered by Rocka.

status

enum<string>

required

Payout status.

Available options:

Processing,

Executing,

Failed,

Done

iban

string

required

Recipient's IBAN (International Bank Account Number).

beneficiaryName

string

required

Recipient's full name.

beneficiaryRef

string

required

Bank reference, which appears on the beneficiary's bank statement once the payout arrives.

requestId

string

The payout's unique identifier (to prevent duplicate requests).