Skip to content

API-6 Document batch/close and batch/summary endpoints in Cloud API REST docs#164

Merged
ecunado merged 3 commits intodevfrom
EFTCLIENT-5390
Feb 13, 2026
Merged

API-6 Document batch/close and batch/summary endpoints in Cloud API REST docs#164
ecunado merged 3 commits intodevfrom
EFTCLIENT-5390

Conversation

@ecunado
Copy link
Contributor

@ecunado ecunado commented Feb 12, 2026

This PR updates the Cloud API documentation to cover the new batch endpoints:

  • POST /batch/close
  • POST /batch/summary

Changes

  • REST endpoints (restendpoints.md)

    • Extended the Batch Operations section to include:
      • POST /batch/close
      • POST /batch/summary:
        • Describes purpose (retrieve batch totals and status for a given terminal + batchNumber)
        • Documents required fields: deviceType, serialNumber, batchNumber
        • Adds example requests and responses
        • Documents validation error behaviour (422 VALIDATION_FAILED when batchNumber is missing)
  • Objects (restobjects.md)

    • Added BatchSummaryRequest:
      • References POST /batch/summary
      • Includes deviceType, serialNumber, batchNumber and optional customerReference
    • Added BatchSummaryResponse:
      • Documents batchNumber, batchStatus, netAmount, transactionCount,
        issuerResponseCode, issuerResponseText, customFields.entry[], and httpStatus
      • Includes example JSON payload

@ecunado ecunado changed the title feat: Document batch/close and batch/summary endpoints in Cloud API REST docs API-6 Document batch/close and batch/summary endpoints in Cloud API REST docs Feb 13, 2026
@ecunado ecunado merged commit b680ef4 into dev Feb 13, 2026
2 checks passed
@ecunado ecunado deleted the EFTCLIENT-5390 branch February 13, 2026 08:05
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

Comments