docs(batching): clarify batch detail pagination and response fields (API-107) - #221
Merged
Merged
Conversation
…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>
Refs: https://handpoint.atlassian.net/browse/API-107 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to the Batch Detail pagination docs (API-107). Changes in
src/partials/functions/batching.mdx.Fix
detailsis 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 whendetailsis 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 returns422if it cannot (same as the OpenAPI spec).Improvements
detailsas an empty page.transactionTypevalues; a pre-authorization is reported asSALE.amountmeaning: settled amount for aCLOSEDbatch, authorized amount for anOPENbatch. Pre-auth increase and capture are exceptions.(Source:
TsysTranslatorFacade.buildBatchDetailElementin viscus.)To check
627120800437and627120800436(…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