docs(restapi): fix Reversal response docs and add ViscusReversalResponse object#194
Open
ecunado wants to merge 2 commits into
Open
docs(restapi): fix Reversal response docs and add ViscusReversalResponse object#194ecunado wants to merge 2 commits into
ecunado wants to merge 2 commits into
Conversation
added 2 commits
July 9, 2026 13:50
…nse object The Reversal endpoint's Returns table linked to DeferredTokenizationResponse (copy-paste from the Deferred Tokenization section, added by cloudapi PR #432). No ViscusReversalResponse object existed to link to, so it is now documented with the real gateway field set. Also fixes the restobjects.md link that pointed to the non-existent restendpoints#reversal-operations anchor, and adds the missing timestamp parameter to the endpoint's Parameters table.
Sibling objects (BatchCloseRequest, MotoReversalRequest, etc.) don't carry implementation-detail prefixes; ViscusReversalRequest/ViscusReversalResponse leaked the internal cloudapi model class name into public docs.
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
1 participant
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
The Reversal endpoint docs (
restendpoints.md#reversal) had a copy-paste mistake from the Deferred Tokenization section (introduced alongside cloudapi#432): the Returns table linked toDeferredTokenizationResponse, and there was noViscusReversalResponseobject to link to instead.ViscusReversalResponsetorestobjects.md, documenting the real gateway field set (httpStatus,acquirerTid,agreementNumber,amount,approvalCode,batchNumber,cardTypeName,currency,customFields,expiryDateMMYY,f25,issuerResponseCode,issuerResponseText,maskedCardNumber,serverDateTime,terminalDateTime,transactionReference,authorizationGuid,originalGuid,reversalGuid) — matching the 200 response example already present inrestendpoints.mdand the real Viscus reversal XML payload.restendpoints.mdto link to the new object and to accurately describe the 200/400/403/422 outcomes (previously described a 400 "not eligible for deferred tokenization" error, which does not apply to reversal).timestampoptional parameter to the Reversal endpoint's Parameters table.ViscusReversalRequestlink inrestobjects.mdthat pointed to the non-existentrestendpoints#reversal-operationsanchor — now points torestendpoints#reversal, matching the actual heading.Test plan
yarn buildsucceeds with no new broken links introduced (verified the only remaining#reversal-operationsbroken-anchor reports are in frozen historical version snapshots that predate this change).ViscusReversalResponsefields againstviscus.service.ts'sreversal()method and the real Viscus reversal XML fixture in cloudapi (fixtures/transaction-status-with-nonce/transaction-result/txn-sale-reversal.xml).