Skip to content

docs(restapi): batch/detail pagination — rename rrn to retrievalReferenceNumber (API-107) - #220

Merged
alexdll31 merged 3 commits into
mainfrom
docs/API-107-batch-detail-pagination
Sep 29, 2026
Merged

alexdll31 merged 3 commits into
mainfrom
docs/API-107-batch-detail-pagination

Conversation

@alexdll31

Copy link
Copy Markdown
Contributor

Summary

  • Rename request field rrn → retrievalReferenceNumber in the Batch Detail section — this matches the correct field name the API expects (the old rrn name was silently ignored by Viscus, so pagination never worked)
  • Document pagination semantics: max 5 transactions per page, descending order, pass the oldest retrievalReferenceNumber from the current page as cursor, stop on empty details
  • Add a "Get next page" curl example tab
  • Fix the bullet summary line that still referenced rrn

Tested in cert (API-107): retrievalReferenceNumber correctly pages through all 17 transactions in batch 132 across 4 calls.

🤖 Generated with Claude Code

alexdll31 and others added 3 commits September 29, 2026 10:49
…/detail

POST /batch/detail is paginated — max 5 transactions per page, descending.
Pass the retrievalReferenceNumber of the oldest item to fetch the next page;
stop when details is empty. Field was previously documented as rrn (broken).
Fixes API-107.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…/detail

- Batch Summary: correct netAmount to minor units, add closedAt field,
  use real response from API-107 cert test
- Batch Detail: replace placeholder with real paginated responses —
  page 1 (5 items), last page (2 items), add key field descriptions

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Rename rrn → retrievalReferenceNumber in Batch Detail (API-107)
- Add pagination explanation and next-page curl example
- Replace placeholder responses with exact real API output:
  Batch Summary: OPEN batch, customFields has salesCount/refundsCount only
  Batch Detail p1: correct field order, customFields.entry as single object
  Batch Detail p2: includes REFUND transaction type example
- Note that closedAt is absent on OPEN batches; netAmount in minor units

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@alexdll31
alexdll31 merged commit c43b8aa into main Sep 29, 2026
2 checks passed
@alexdll31
alexdll31 deleted the docs/API-107-batch-detail-pagination branch September 29, 2026 09:21
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.

1 participant