Skip to content

EFTCLIENT-5390 Document /batch/close endpoint in Cloud API REST docs#159

Merged
ecunado merged 1 commit intodevfrom
EFTCLIENT-5390
Dec 4, 2025
Merged

EFTCLIENT-5390 Document /batch/close endpoint in Cloud API REST docs#159
ecunado merged 1 commit intodevfrom
EFTCLIENT-5390

Conversation

@ecunado
Copy link
Contributor

@ecunado ecunado commented Dec 4, 2025

Add documentation for the batch close operation exposed via Cloud API.

Changes

  • Introduce a “Batch Operations” section in restendpoints.md.
  • Document POST /batch/close:
    • Usage and typical scenarios.
    • Parameters (ApiKeyCloud header + BatchCloseRequest body).
    • Return codes (200, 400, 422, 5xx) and behaviour notes.
    • Examples for a successful close and a validation error (missing batchNumber).
  • Add Batch objects in restobjects.md:
    • BatchCloseRequest
    • BatchCloseResponse
  • Cross-link endpoint and objects (restendpointsrestobjects) for easier navigation.

@ecunado ecunado merged commit 8fdb61c into dev Dec 4, 2025
2 checks passed
@ecunado ecunado deleted the EFTCLIENT-5390 branch December 4, 2025 10:37
@ecunado ecunado restored the EFTCLIENT-5390 branch February 12, 2026 13:07
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