reorganize REST API endpoints and expand code examples#183
Merged
Conversation
moved tip-adjust and get token operations under no-reader Title. Added refund and reversal request examples under /transactions endpoint with notes of not sending the transactionReference value on those linked operations also added example for unlinked refunds with txnReference value without originalGuid and explanatory note
ecunado
approved these changes
Apr 15, 2026
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
2 participants
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.
Moved /transactions/{guid}/tip-adjustment and /transactions/{guid}/token under the Endpoints Not Requiring a Payment Terminal section, which better reflects their nature as terminal-independent operations.
Added response examples for /transactions/{transactionReference}/status/{selector}, with three tabs covering all three selector variants:
selector=all — returns an array of all transactions linked to that reference
selector={index} — returns a single transaction by position
selector=last — returns the most recent transaction
Expanded request examples for the /transactions endpoint with four tabs (previously only Sale was shown):
Sale (no callback) / Sale (with callback) — existing examples, renamed for clarity
Refund — linked refund using originalTransactionId
Unlinked Refund — original refund using transactionReference with no originalTransactionId
Reversal (refundReversal) — with notes on partial vs full reversal behavior per acquirer
Added a note clarifying transactionReference usage: it should only be sent on original operations (Sale, Pre-Auth, MOTO Sale, unlinked Refund). Linked operations inherit the original transaction's reference automatically.
All changes are applied to both the live docs (restapi/) and the versioned snapshot (restapi_versioned_docs/version-REST API 2.27.0/).