Skip to content

docs(batching): clarify batch detail pagination and response fields (API-107) - #221

Merged
alexdll31 merged 2 commits into
devfrom
docs/API-107-batch-detail-pagination-notes
Sep 29, 2026
Merged

alexdll31 merged 2 commits into
devfrom
docs/API-107-batch-detail-pagination-notes

Conversation

@ecunado

@ecunado ecunado commented Sep 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to the Batch Detail pagination docs (API-107). Changes in src/partials/functions/batching.mdx.

Fix

  • Stop condition: the closing note said "Keep paginating until details is empty or has fewer than 5 items". That is wrong: the gateway leaves out transaction types that it does not map (for example voids), so a page can have fewer than 5 items while older transactions remain. The page now says to stop only when details is empty or missing, with a warning admonition.
  • batchNumber: was documented as required for Summary and Detail. In CloudAPI it is optional for all three operations. The gateway resolves the current batch of the terminal and returns 422 if it cannot (same as the OpenAPI spec).

Improvements

  • Pagination as numbered steps. Explicit that the page size is fixed at 5 and that the "next page" contains older transactions.
  • Short loop example. It treats a missing details as an empty page.
  • New Response fields table:
    • transactionType values; a pre-authorization is reported as SALE.
    • amount meaning: settled amount for a CLOSED batch, authorized amount for an OPEN batch. Pre-auth increase and capture are exceptions.
      (Source: TsysTranslatorFacade.buildBatchDetailElement in viscus.)
  • Notes: new transactions in an open batch need a new first call. For reconciliation totals, use Batch Summary.

To check

  • Page 2 example: the last two RRNs are 627120800437 and 627120800436 (…1208…); the others are …1218…. I did not change them. If they are not the real values from cert, it is probably a typo.

Testing

  • npm run build: success.

Related: handpoint/cloudapi#491, handpoint/viscus#3174
Refs: https://handpoint.atlassian.net/browse/API-107

🤖 Generated with Claude Code

ecunado and others added 2 commits September 29, 2026 12:24
…API-107)

- Fix the stop condition: a page can have fewer than 5 items while older
  transactions remain (the gateway leaves out unmapped types), so stop
  only on an empty or missing details.
- Numbered pagination steps, a warning, and a loop example.
- Document details[] fields: transactionType values, and amount meaning
  for open vs closed batches.
- Notes on open batches (new transactions and the RRN cursor) and on
  using Batch Summary for reconciliation.
- batchNumber is optional for all batch operations: the gateway resolves
  the current batch and returns 422 if it cannot.

Refs: https://handpoint.atlassian.net/browse/API-107

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@alexdll31
alexdll31 merged commit ea1e778 into dev Sep 29, 2026
@ecunado
ecunado deleted the docs/API-107-batch-detail-pagination-notes branch September 29, 2026 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants