Delete an item from a PIX batch

DELETE

https://client.api.corpx.com/v1/accounts/:accountId/pix/batches/:batchId/items/:itemId

DELETE

/v1/accounts/:accountId/pix/batches/:batchId/items/:itemId

curl -X DELETE https://client.api.corpx.com/v1/accounts/accountId/pix/batches/batchId/items/itemId \
     -H "X-Content-SHA256: X-Content-SHA256" \
     -H "X-Request-Signature: X-Request-Signature" \
     -H "X-Request-Timestamp: X-Request-Timestamp" \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>"

{
  "batchId": "pxb_3f9c2a1b7d4e5f60718293a4b5c6d7e8",
  "name": "Folha de setembro",
  "status": "DRAFT",
  "totalItems": 1,
  "totalAmount": "1436.85",
  "completedItems": 0,
  "failedItems": 0,
  "limits": {
    "maxItems": 50,
    "source": "default"
  },
  "createdAt": "2026-09-30T13:08:12Z",
  "updatedAt": "2026-09-30T13:09:00Z",
  "statistics": {
    "total": 1,
    "pending": 1,
    "processing": 0,
    "completed": 0,
    "failed": 0,
    "reviewedOk": 0,
    "invalid": 0,
    "totalAmount": "1436.85",
    "validAmount": "0.00",
    "completedAmount": "0.00",
    "failedAmount": "0.00",
    "progressPercentage": 0
  },
  "items": [],
  "page": 1,
  "pageSize": 50,
  "totalPages": 1,
  "hasNext": false
}

Removes one item while the batch is DRAFT or REVIEWED. Deleting from a REVIEWED batch resets it to DRAFT. After dispatch the batch is immutable.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired

Account identifier.

batchIdstringRequired

PIX batch identifier (pxb_…) returned by the create endpoint.

itemIdstringRequired

Batch item identifier (pxi_…) returned in items[].

Headers

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

Response

Item deleted; current batch and first item page

batchIdstring

Batch identifier (pxb_…).

namestring

Optional operator-facing name; empty when omitted.

statusenum

Batch lifecycle. DRAFT and REVIEWED are editable (editing a REVIEWED batch returns it to DRAFT). REVIEWING is the asynchronous pre-flight. Dispatch requires REVIEWED. COMPLETED, PARTIAL_FAILED and FAILED are terminal and the only states with receipts.

totalItemsinteger0-5000

Number of staged items.

totalAmountstringformat: "^[0-9]+\.[0-9]{2}$"

Amount in BRL as a decimal string with two places (1234.56).

completedItemsinteger

Items settled so far.

failedItemsinteger

Items failed so far.

limitsobject

Effective item limit for this account and where it comes from.

createdAtdatetime

Draft creation instant, in UTC.

updatedAtdatetime

Last persisted update, in UTC.

statisticsobject

Live item counters and amounts.

itemslist of objects

Current page of items.

pageinteger

Current item page.

pageSizeinteger

Requested item page size.

totalPagesinteger

Number of item pages.

hasNextboolean

Whether another item page exists.

reviewobjectOptional

Summary written when the review finishes (or aborts).

reviewedAtdatetimeOptional

Instant the last review finished.

acknowledgedAtdatetimeOptional

Instant the caller acknowledged the review at dispatch.

dispatchedAtdatetimeOptional

Instant the batch was queued.

completedAtdatetimeOptional

Instant every item reached an outcome.

Errors

403

Forbidden Error

404

Not Found Error

409

Conflict Error