List bulk payouts

GET

/integration/bulk-payouts

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

Returns a page of your organization's bulk payouts with their states, item counts and amounts. The rows of a bulk payout are returned by GET /integration/bulk-payouts/{id}/items.

Filter the list with the query parameters, for example by AccountId, States, ExternalId or a creation period (CreatedFrom, CreatedTo). Bulk payouts are sorted by creation time, newest first, unless SortBy is set. PageNumber starts at 1; PageSize defaults to 10.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://my.test-1.account.finlego.com/api/merchant/integration/bulk-payouts?AccountId=undefined&States=undefined&ExternalId=undefined&CreatedFrom=undefined&CreatedTo=undefined&SortBy=undefined&SortOrder=undefined&PageNumber=undefined&PageSize=undefined' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "data": [
        {
            "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
        }
    ],
    "page": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalRecords": 0,
        "totalPages": 0
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Modified at 2026-09-29 11:11:01

Upload bulk payout

Get bulk payout