docs: add direction field to transaction examples#618
Conversation
Sync documentation with af3d8de which added a required direction field (CREDIT/DEBIT) to Transaction and CardTransaction schemas. All transaction response examples in guides and quickstarts now include the direction field: - OUTGOING transactions: direction: "DEBIT" - INCOMING transactions: direction: "CREDIT" Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Greptile SummaryAdds the new required
Confidence Score: 5/5Safe to merge — purely additive documentation change with no logic or API contract modifications. All 27 transaction examples across 16 files were updated and the OUTGOING→DEBIT / INCOMING→CREDIT mapping is applied uniformly with no omissions or inversions. The card-specific snippet files were correctly left untouched since their examples use a different transaction model. Nothing executable was changed. No files require special attention.
|
| Filename | Overview |
|---|---|
| mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx | Adds direction field to 4 OUTGOING transaction examples; all correctly mapped to DEBIT. |
| mintlify/payouts-and-b2b/quickstart.mdx | Adds direction: CREDIT to INCOMING funding transaction and direction: DEBIT to OUTGOING transfer — both correct. |
| mintlify/payouts-and-b2b/payment-flow/send-payment.mdx | Adds direction: DEBIT to 3 OUTGOING transaction examples (PENDING initial response, COMPLETED webhook, cross-currency quote execution). |
| mintlify/global-p2p/sending-receiving-payments/receiving-payments.mdx | Adds direction: CREDIT to both INCOMING transaction examples (PENDING and COMPLETED); correct direction for receiving payments. |
| mintlify/ramps/platform-tools/sandbox-testing.mdx | Adds direction: DEBIT to the on-ramp completion webhook example; OUTGOING/DEBIT is correct — Grid is disbursing BTC to the end user. |
| mintlify/snippets/error-handling.mdx | Adds direction: DEBIT to OUTGOING failed example and direction: CREDIT to INCOMING failed example; directions are correct. |
| mintlify/snippets/reconciliation/reconciliation.mdx | Adds direction: DEBIT to both OUTGOING transaction examples in webhook payload and GET response. |
| mintlify/snippets/sending/cross-currency.mdx | Adds direction: DEBIT to both OUTGOING cross-currency transaction examples (USD→EUR quote and USDC→EUR blockchain deposit). |
| mintlify/snippets/sending/same-currency.mdx | Adds direction: DEBIT to PENDING and COMPLETED OUTGOING same-currency transaction examples. |
| mintlify/ramps/quickstart.mdx | Adds direction: DEBIT to both OUTGOING ramp transaction examples (PROCESSING initial and COMPLETED webhook). |
| mintlify/global-p2p/quickstart.mdx | Adds direction: DEBIT to 2 OUTGOING global P2P transaction examples (PROCESSING initial and COMPLETED webhook). |
| mintlify/payouts-and-b2b/payment-flow/list-transactions.mdx | Adds direction: DEBIT to the single OUTGOING transaction in the list-transactions response example. |
| mintlify/ramps/platform-tools/webhooks.mdx | Adds direction: DEBIT to the single OUTGOING ramp webhook payload example. |
| mintlify/rewards/developer-guides/listing-transactions.mdx | Adds direction: DEBIT to the OUTGOING transaction in the listing-transactions response example. |
| mintlify/rewards/quickstart.mdx | Adds direction: DEBIT to the OUTGOING BTC transfer webhook example in the rewards quickstart. |
| mintlify/rewards/developer-guides/distributing-rewards.mdx | Adds direction: DEBIT to OUTGOING BTC reward distribution webhook example. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
T[Transaction] --> TYPE{type}
TYPE -->|OUTGOING| DEBIT["direction: DEBIT\n(funds leave platform)"]
TYPE -->|INCOMING| CREDIT["direction: CREDIT\n(funds arrive at platform)"]
DEBIT --> D1[payouts, ramps, rewards, global-p2p sends]
CREDIT --> C1[payouts funding, global-p2p receives]
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
T[Transaction] --> TYPE{type}
TYPE -->|OUTGOING| DEBIT["direction: DEBIT\n(funds leave platform)"]
TYPE -->|INCOMING| CREDIT["direction: CREDIT\n(funds arrive at platform)"]
DEBIT --> D1[payouts, ramps, rewards, global-p2p sends]
CREDIT --> C1[payouts funding, global-p2p receives]
Reviews (1): Last reviewed commit: "docs: add direction field to transaction..." | Re-trigger Greptile
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Summary
directionfield (CREDIT/DEBIT) to Transaction and CardTransaction schemasdirectionfield:OUTGOINGtransactions →"direction": "DEBIT"INCOMINGtransactions →"direction": "CREDIT"Test plan
make lintpassesdirectionfield aftertype🤖 Generated with Claude Code