docs(sender): document optional senderFeeAddress on V2 create order - #22
Open
onahprosper wants to merge 1 commit into
Open
docs(sender): document optional senderFeeAddress on V2 create order#22onahprosper wants to merge 1 commit into
onahprosper wants to merge 1 commit into
Conversation
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
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.
Description
Documents the optional
senderFeeAddressfield on V2POST /v2/sender/orders, aligned with aggregator PR #972.What changed for integrators
senderFee,senderFeePercent, or a profile-configured fee), a fee recipient address is required — either configured on the sender profile or passed assenderFeeAddresson the create payload.senderFeeAddressis not required.senderFeeandsenderFeePercentremain mutually exclusive.Docs updated
openapi-v2.yaml— addsenderFeeAddress; clarify fee field descriptions (API reference page pulls from this)implementation-guides/sender-api-integration.mdx— request fields table, Sender Fees section with onramp examples, v1 vs v2 tableresources/changelog.mdx— Q3 2026 entry; correct historical v2 sender-fee rowconcepts/participants.mdx— sender fee model noteNo breaking API or contract changes; documentation only.
References
Testing
Review OpenAPI
V2PaymentOrderPayloadand MDX examples against aggregatorresolveV2SenderFeebehaviorConfirm Mintlify preview renders Initiate Order (v2) params and Sender Fees section with examples
No automated tests (docs-only change)
This change adds test coverage for new/changed/fixed functionality
Checklist
mainBy submitting a PR, I agree to Paycrest's Contributor Code of Conduct and Contribution Guide.