Get bulk payout

Early access - contact your account manager to enable bulk payouts for your organization.

Returns a bulk payout by the identifier returned on upload or received in a webhook: its state, the number of items in each state, the total amount and fees.

state is:

validating while the file is being checked;

validated when every row is valid and the bulk payout is ready to be submitted. estimatedFeeAmount shows the expected fees, and expiresAt shows when the bulk payout expires if it is not submitted;

validationFailed when at least one row is invalid; the errors are listed per row in GET /integration/bulk-payouts/{id}/items;

processing after submission, while the payments are being executed;

completed, partiallyCompleted or failed when every payment has reached a final state: all payments completed, some of them completed, or none of them completed;

cancelled if the bulk payout was cancelled before any payment completed;

expired if a validated bulk payout was not submitted within 24 hours.

For a validationFailed, failed, cancelled or expired bulk payout, reason explains the state. Use this endpoint to poll the bulk payout as an alternative to webhooks.

Returns 404 Not Found if the bulk payout does not exist or belongs to another organization.

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "id": "3f6c2a4e-8b1d-4c7a-9e2f-5d8b7a1c0e94",
    "externalId": "payroll-2026-09",
    "accountId": "b7e2d9c1-4a5f-4e8b-9c3d-2f1a6e7b8d90",
    "currency": "EUR",
    "paymentMethod": "sepa",
    "state": "validating",
    "reason": null,
    "fileName": "payroll-september.csv",
    "fileFormat": "csv",
    "itemCounts": {
        "total": 120,
        "valid": 120,
        "invalid": 0,
        "processing": 0,
        "completed": 0,
        "failed": 0,
        "cancelled": 0
    },
    "totalAmount": 48250.75,
    "estimatedFeeAmount": 125,
    "completedAmount": 0,
    "feeAmount": 0,
    "createdAt": "2026-09-29T09:15:00Z",
    "expiresAt": "2026-09-30T09:15:12Z",
    "submittedAt": null,
    "completedAt": null
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request

Request Code Samples

Responses