List bulk payout items - Framnex for Developers

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

Returns a page of the rows of a bulk payout, sorted by rowNumber. Each item shows the parsed payment, its state and:

errors - the validation errors of an invalid row, one entry per field;

transferId - the identifier of the outgoing transfer created for the row after submission. Use it with GET /integration/transfers/{id} and to match the outgoingTransferExecuted and outgoingTransferCancelled webhooks;

reason - why the payment of a failed row was not executed.

Set States to invalid to list only the rows that must be fixed. PageNumber starts at 1; PageSize defaults to 10.

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "data": [
        {
            "id": "9a1d4f7e-2c3b-4e8a-b5d6-0f1e2d3c4b5a",
            "rowNumber": 1,
            "externalId": "emp-0042",
            "amount": 3200,
            "reference": "Salary September 2026",
            "beneficiary": {
                "credentials": {
                    "bankDetails": {
                        "bankName": "string",
                        "bankCountry": "string",
                        "bankRegion": "string",
                        "bankAddress": "string",
                        "bic": "string",
                        "intermediaryBic": "string",
                        "bankCode": "string",
                        "routingNumber": "string",
                        "sortCode": "string",
                        "branchCode": "string"
                    },
                    "type": "sepa",
                    "iban": "string",
                    "reference": "string"
                },
                "legalEntity": {
                    "address": {
                        "streetLine1": "string",
                        "streetLine2": "string",
                        "city": "string",
                        "state": "string",
                        "zip": "string",
                        "country": "string"
                    },
                    "type": "business",
                    "legalName": "string"
                }
            },
            "state": "valid",
            "errors": [
                {
                    "field": "iban",
                    "code": "INVALID_FORMAT",
                    "message": "The IBAN checksum is invalid."
                }
            ],
            "transferId": null,
            "feeAmount": null,
            "reason": null
        }
    ],
    "page": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalRecords": 0,
        "totalPages": 0
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error