Cancel a payout batch

Stop a run before any payout exists.

POST

POST/payments/organizations/{orgId}/payouts/batches/{batchId}/cancel

IDEMPOTENCY_KEY=$(uuidgen)  # new key per call; reuse it only to retry this exact request
curl -s -X POST "$AVVIO_BASE_URL/payments/organizations/$AVVIO_ORG_ID/payouts/batches/$batchId/cancel" \
  -H "x-api-key: $AVVIO_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

const batchId = '<batchId>';
const idempotencyKey = crypto.randomUUID(); // new key per call; reuse it only to retry this exact request

const res = await fetch(`${process.env.AVVIO_BASE_URL}/payments/organizations/${process.env.AVVIO_ORG_ID}/payouts/batches/${batchId}/cancel`, {
  method: 'POST',
  headers: {
    'x-api-key': process.env.AVVIO_API_KEY,
    'Idempotency-Key': idempotencyKey,
  },
});
console.log(res.status, await res.json());

import os
import uuid
import requests

batchId = "<batchId>"
idempotency_key = str(uuid.uuid4())  # new key per call; reuse it only to retry this exact request

res = requests.post(
    f"{os.environ['AVVIO_BASE_URL']}/payments/organizations/{os.environ['AVVIO_ORG_ID']}/payouts/batches/{batchId}/cancel",
    headers={
        "x-api-key": os.environ["AVVIO_API_KEY"],
        "Idempotency-Key": idempotency_key,
    },
)
print(res.status_code, res.json())

200OK

{
  "batchId": "cmf3k2xg00009q8b7v0w2x4yz",
  "externalReferenceId": "payroll-2026-09-01",
  "status": "awaiting_confirmation",
  "autoCommit": false,
  "counts": {
    "received": 0,
    "invalid": 1,
    "validated": 249,
    "creating": 0,
    "created": 0,
    "create_failed": 0,
    "canceled": 0,
    "requires_review": 0
  },
  "estimatedSourceTotal": "49800.00",
  "createdAt": "2026-09-01T14:03:11.000Z",
  "updatedAt": "2026-09-01T14:03:19.000Z",
  "completedAt": null
}

{
  "type": "IDEMPOTENCY_KEY_REQUIRED",
  "status": 400,
  "detail": "Idempotency-Key header is required. Use a unique value per operation, and reuse it to retry.",
  "resolution": "Add an Idempotency-Key header with a unique value for this operation.",
  "requestId": "req-9f2",
  "message": "Idempotency-Key header is required. Use a unique value per operation, and reuse it to retry.",
  "statusCode": 400
}

{
  "type": "UNAUTHORIZED",
  "status": 401,
  "detail": "Invalid API key",
  "resolution": "Check the API key was copied whole and has not been revoked.",
  "requestId": "req-9bz",
  "message": "Invalid API key",
  "statusCode": 401
}

{
  "type": "FORBIDDEN",
  "status": 403,
  "detail": "This API key cannot access that organization",
  "resolution": "This key is scoped to a different organization.",
  "requestId": "req-9d0",
  "message": "This API key cannot access that organization",
  "statusCode": 403
}

{
  "type": "BATCH_NOT_FOUND",
  "status": 404,
  "detail": "No payout batch cmf3k2xg00009q8b7v0w2x4yz belongs to this organization.",
  "requestId": "req-9na",
  "message": "No payout batch cmf3k2xg00009q8b7v0w2x4yz belongs to this organization.",
  "statusCode": 404
}

{
  "type": "PAYOUT_BATCH_NOT_CANCELABLE",
  "status": 409,
  "detail": "This batch is creating and can no longer be canceled. A batch is cancelable until creation starts; after that, cancel individual payouts via POST .../payouts/{payoutId}/cancel while they are still pending.",
  "requestId": "req-a5s",
  "message": "This batch is creating and can no longer be canceled. A batch is cancelable until creation starts; after that, cancel individual payouts via POST .../payouts/{payoutId}/cancel while they are still pending.",
  "statusCode": 409
}

{
  "type": "RATE_LIMITED",
  "status": 429,
  "detail": "ThrottlerException: Too Many Requests",
  "resolution": "Back off and retry after the Retry-After interval.",
  "requestId": "req-9e1",
  "message": "ThrottlerException: Too Many Requests",
  "statusCode": 429
}

Path parameters

orgIdstringRequired
The opaque organization id issued to you, normally CUID-shaped (for example cmsx…). It is not an org_-prefixed alias. Pass it unchanged in every organization-scoped path.
batchIdstringRequired
From the 202 that accepted the run, or the batch list.

Headers

Idempotency-KeystringRequired
A unique value per logical operation, 1-255 chars of A-Z a-z 0-9 _ . : -.
More
Reuse it to retry. Same key with the same body replays the stored response; same key with a different body is a 409, because answering with the first call's result would hand you a receipt for a payout you did not request. A 4xx releases the key, so you can fix the body and reuse it.

Reuse it; do not generate one per attempt. A key minted per attempt defeats replay entirely: every retry looks like a new request, so every retry pays. We also watch for an identical body arriving under a different key within 15 minutes and refuse it with DUPLICATE_REQUEST_DETECTED.

Records are kept for 7 days. That is a retention window only: there is no path where an expired key is re-executed.

Behavior

Honored while the batch is received, validating or awaiting_confirmation, before creation starts, so no payout ever exists from a canceled batch. Once creation begins the run is committed; cancel individual payouts while they are still pending via POST .../payouts/{payoutId}/cancel instead. Refused with 409 PAYOUT_BATCH_NOT_CANCELABLE after that point.

Responses

200The batch, now canceled.

Body · PayoutBatch

batchIdstringRequired
externalReferenceIdstring | nullRequired
Your own run id, echoed back.
statusstringRequired
A batch moves received -> validating -> either creating (autoCommit, zero errors) or awaiting_confirmation (anything else) -> creating -> completed. canceled is reachable until creation starts; failed means the run broke, not a line. The batch tracks creation; payouts settle on their own lifecycle afterwards.
Allowed values:receivedvalidatingawaiting_confirmationcreating
Show 3 more values
completedcanceledfailed
autoCommitbooleanRequired
countsobjectRequired
Lines by status. The values sum to the number of lines submitted.
Show 8 properties
- receivedintegerRequired
- invalidintegerRequired
- validatedintegerRequired
- creatingintegerRequired
- createdintegerRequired
- create_failedintegerRequired
- canceledintegerRequired
- requires_reviewintegerRequired
estimatedSourceTotalstring | nullRequired
Advisory. What the valid lines will draw from your balance, set when validation finishes; null while validation is running and when any line locks the destination side (no rate is consulted at validation time). Compare against GET /balance before confirming. Half a paid payroll is worse than none.
errorobjectOptional
Present only when status is failed, with the run-level reason.
createdAtstring<date-time>Required
updatedAtstring<date-time>Required
completedAtstring<date-time> | nullRequired

Errors

400
Missing (IDEMPOTENCY_KEY_REQUIRED) or malformed (IDEMPOTENCY_KEY_INVALID) Idempotency-Key.
401
The key was refused. Nothing ran.
- UNAUTHORIZED: missing, invalid or revoked, or a key on a route that does not accept one.
- KEY_EXPIRED: the key passed the expiry it was issued with. Issue a new one; an expired key cannot be rotated.
- KEY_IP_NOT_ALLOWED: the key is pinned to source addresses and this request came from another.
403
A valid key that may not make this write. Nothing was changed.
- FORBIDDEN: the key belongs to a different organization.
- ACCOUNT_BLOCKED: API access for your organization is suspended.
- LIVE_KEY_ORG_NOT_APPROVED: a live key, before we have approved your business verification. Use a test key until then.
- INSUFFICIENT_SCOPE: a read-only key. Issue one with the write scope.
404
BATCH_NOT_FOUND: no such batch in this organization.
409
PAYOUT_BATCH_NOT_CANCELABLE: creation already started. Or an idempotency conflict (IDEMPOTENCY_KEY_CONFLICT, IDEMPOTENCY_KEY_REQUEST_IN_PROGRESS).
429
Too many requests. The default ceiling is 100 requests per minute per API credential on a 60-second window. High-volume payout and reconciliation routes declare a 600/minute override, and batch submission a 30/minute ceiling. A separate 2,000/minute per-source-IP abuse ceiling always applies.

Obey Retry-After; it is in seconds and is authoritative. A 429 means the request was refused before the handler ran. Retry reads normally; retry an idempotent mutation with its same Idempotency-Key.

Error body · Error

typestringRequired
Stable machine-readable code.
detailstringRequired
What went wrong, in a sentence. Always a string, so detail.toLowerCase() is safe.
More
This is the field to read on BAD_REQUEST and PROVIDER_REJECTED, where the type alone does not name the condition.
messagestringRequired
The same text as detail, kept for integrations written before detail existed. Read detail.
resolutionstringOptional
What to do about it, when there is a specific answer. It is not on every error (it is absent on BAD_REQUEST, NOT_FOUND, PAYOUT_NOT_CANCELABLE and DESTINATION_ACCOUNT_NOT_FOUND), so treat it as optional and fall back to detail.
statusintegerRequired
HTTP status, repeated in the body.
statusCodeintegerRequired
The same value as status, kept for integrations written before status existed. Read status.
requestIdstringRequired
Quote this to support and we can find the exact request. Also sent as the x-request-id response header, which is the only place it appears on a successful response. Success bodies do not carry it. Send your own x-request-id on the request and we use it, so your trace and ours share one identifier; otherwise we mint one.
errorsarray of stringOptional
Present on VALIDATION_ERROR; names each field that failed.
originalIdempotencyKeystringOptional
On DUPLICATE_REQUEST_DETECTED only. Send the request again with this to receive the original payout instead of making a second one. Without it there is no way to recover except by risking a double payment.
originalPayoutIdstringOptional
On DUPLICATE_REQUEST_DETECTED only. The payout the first request created.
originalBatchIdstringOptional
On a batch DUPLICATE_REQUEST_DETECTED. The run the first request created.
originalRequestIdstringOptional
On a 409 PAYOUT_OUTCOME_UNKNOWN replay. The requestId of the call whose outcome is unknown; quote it to support.
existingRecipientIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The recipient in your organization that already holds this account.
existingMethodIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The payment method on that recipient.

Branch on type, never on the status or the message. Every error type is listed with what to do about it.

Avvio Partner Payouts · Payout batches · operation cancelPayoutBatch

Try it: Cancel a payout batch

POST https://api.avvio.xyz/business/api/v1/payments/organizations/{orgId}/payouts/batches/{batchId}/cancel

API key Required

Test keys only. Sent as x-api-key through this site's proxy to the Avvio API, never saved, and cleared when you close this dialog.

orgId pathRequired

batchId pathRequired

Idempotency-Key headerRequired

Was this page helpful?