Cancel bulk payout - Framnex for Developers

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

Cancels a bulk payout.

Before submission (validating or validated), the bulk payout becomes cancelled, and no money is moved.

During processing, the rows whose payments have not started yet become cancelled. Payments that have already started are not affected and reach their final state as usual. The bulk payout then becomes partiallyCompleted if any payment completed, or cancelled otherwise, and the bulkPayoutCompleted webhook is sent.

The response contains the bulk payout after the cancellation request.

Errors: 404 Not Found if the bulk payout does not exist; 422 Unprocessable Content if the bulk payout is already in a final state.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

🟠422Parameter Error

🔴500Server Error