Repository navigation
docs(vc): document virtual currency transaction labels - #836
Merged
Merged
Conversation
Add operation, feature, customer_placement_id, reference_id, is_sandbox, store and store_transaction_id to the virtual currency transaction request, response and history item. Document the 201 response with the full transaction, and align error responses with what the endpoints return. Add a Label transactions section to the overview and label the quickstart and initial-balance examples.
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.
Summary
The server-side API for virtual currency transactions now accepts seven optional fields that label a transaction:
operation,feature,customer_placement_id,reference_id,is_sandbox,store, andstore_transaction_id. The POST response and the transaction history return them. This PR documents them and corrects the reference where it didn't match the endpoints.API reference (
adapty-api.yaml)operationvalues.201 Created, not200. The response is now the full transaction (same shape as a history item) plusbalancesandresponse_created_at.store+store_transaction_id).400 validation_error, and the new error codes areparse_errorandunknown_store. Removed:403 feature_not_enabled,422,409 duplicate_source_transaction, and theamount_zero/empty_items/duplicate_currencycodes.400 validation_error. Removes403.400isvalidation_error(missing profile header). Removes403.Guides
operationvalues,featureformat with good and bad examples, the other fields, a warning about double-crediting linked products, and what happens to older transactions.operation: spendandfeature: image_generation.operation: rewardandfeature: welcomeinstead ofmetadata.reason. The response example now shows the new shape.Notes for review
operationlists the values Adapty sets on its own transactions:top_upfor store purchases, renewals, and trials,refund,expiry, andrewardfordashboard_transaction. These follow the backend mapping onmaster.Verification
check-mdx-parseandlint-mdxpass on the changed articles.main.