Sync docs with recent OpenAPI schema changes#471
Conversation
Updates documentation to reflect recent schema changes: 1. **Internal Account Status** (cff4d23): Added `status` and `type` fields to internal account examples. Added `INTERNAL_ACCOUNT.STATUS_UPDATED` webhook documentation. 2. **Webhook Type Correction**: Fixed all references from legacy `ACCOUNT_STATUS` type to the correct `INTERNAL_ACCOUNT.BALANCE_UPDATED` enum value across all documentation files. 3. **Colombia (COP) Support** (2033ecc): Added Colombia tab to external-accounts.mdx showing both bank transfer and mobile money (Nequi/Daviplata) flows with new fields (bankName, bankAccountType, documentType, documentNumber). Files updated: - mintlify/platform-overview/core-concepts/account-model.mdx - mintlify/ramps/accounts/internal-accounts.mdx - mintlify/ramps/platform-tools/sandbox-testing.mdx - mintlify/ramps/platform-tools/webhooks.mdx - mintlify/rewards/platform-tools/sandbox-testing.mdx - mintlify/rewards/quickstart.mdx - mintlify/snippets/depositing-funds.mdx - mintlify/snippets/external-accounts.mdx - mintlify/snippets/internal-accounts.mdx - mintlify/snippets/sending/cross-currency.mdx Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Greptile SummaryThis PR syncs the Mintlify documentation with recent OpenAPI schema changes, touching 10 MDX files across ramps, rewards, and shared snippets.
Confidence Score: 4/5Safe to merge after fixing the stale webhook payload in cross-currency.mdx — all other files are consistently updated. Nine of the ten changed files are correctly updated. The one exception is the USDC cross-currency deposit step in cross-currency.mdx, where only the type string was changed but the JSON body still shows the old flat fields (accountId, oldBalance, newBalance) rather than the new data-envelope shape. Developers following that example would wire up balance tracking against a schema that no longer matches what the API actually sends. mintlify/snippets/sending/cross-currency.mdx — the webhook payload example needs its JSON body updated to match the new envelope structure.
|
| Filename | Overview |
|---|---|
| mintlify/snippets/sending/cross-currency.mdx | Webhook type string was updated to INTERNAL_ACCOUNT.BALANCE_UPDATED but the JSON payload example retains the old flat structure (accountId, oldBalance, newBalance), inconsistent with the new envelope format used in all other updated files. |
| mintlify/ramps/platform-tools/webhooks.mdx | Tab renamed from ACCOUNT_STATUS to INTERNAL_ACCOUNT.BALANCE_UPDATED; new INTERNAL_ACCOUNT.STATUS_UPDATED tab added; both payload examples and JavaScript handler code correctly use the new data-envelope schema. |
| mintlify/snippets/external-accounts.mdx | Added Colombia (COP) tab with bank transfer and mobile money (Nequi/Daviplata) examples, following the same pattern as adjacent country tabs. |
| mintlify/snippets/internal-accounts.mdx | Added type and status fields to internal account JSON examples; updated webhook reference from ACCOUNT_STATUS to INTERNAL_ACCOUNT.BALANCE_UPDATED. |
| mintlify/rewards/quickstart.mdx | Webhook payload example updated to new envelope format (data wrapper, id, type, status, balance) replacing old flat structure (accountId, oldBalance, newBalance). |
| mintlify/ramps/accounts/internal-accounts.mdx | Balance-updated webhook payload updated to new envelope format; webhook type renamed consistently. |
| mintlify/platform-overview/core-concepts/account-model.mdx | Corrected webhook type references; added INTERNAL_ACCOUNT.STATUS_UPDATED alongside INTERNAL_ACCOUNT.BALANCE_UPDATED. |
| mintlify/ramps/platform-tools/sandbox-testing.mdx | Single-line update replacing ACCOUNT_STATUS with INTERNAL_ACCOUNT.BALANCE_UPDATED in a Check callout. |
| mintlify/rewards/platform-tools/sandbox-testing.mdx | Single-line update replacing ACCOUNT_STATUS with INTERNAL_ACCOUNT.BALANCE_UPDATED in a prose description. |
| mintlify/snippets/depositing-funds.mdx | Webhook type reference updated from ACCOUNT_STATUS to INTERNAL_ACCOUNT.BALANCE_UPDATED in an Info callout. |
Sequence Diagram
sequenceDiagram
participant Client
participant Grid API
participant Webhook Endpoint
Client->>Grid API: POST /customers/external-accounts (COP)
Grid API-->>Client: ExternalAccount created
Client->>Grid API: POST /quotes (cross-currency USDC→COP)
Grid API-->>Client: Quote with fundingAddress
Client->>Grid API: Send USDC to fundingAddress (blockchain)
Grid API->>Grid API: Detect blockchain deposit
Grid API->>Webhook Endpoint: INTERNAL_ACCOUNT.BALANCE_UPDATED
Grid API->>Grid API: Execute cross-currency transfer
Grid API->>Webhook Endpoint: OUTGOING_PAYMENT.COMPLETED
Note over Grid API,Webhook Endpoint: INTERNAL_ACCOUNT.STATUS_UPDATED sent on status transitions
Comments Outside Diff (1)
-
mintlify/snippets/sending/cross-currency.mdx, line 234-242 (link)The webhook type was updated to
INTERNAL_ACCOUNT.BALANCE_UPDATEDbut the payload example still uses the old flat structure (accountId,oldBalance,newBalanceat root level). Every other file in this PR migrated to the new envelope format with adatawrapper,id, andbalance. Developers copying this example will build against the wrong schema and their balance-tracking code will silently receiveundefinedfor all fields.json
{
"id": "Webhook:019542f5-b3e7-1d02-0000-000000000026",
"type": "INTERNAL_ACCOUNT.BALANCE_UPDATED",
"timestamp": "2025-10-03T15:05:00Z",
"data": {
"id": "InternalAccount:019542f5-b3e7-1d02-0000-000000000025",
"type": "INTERNAL_CRYPTO",
"status": "ACTIVE",
"balance": {
"amount": 10000,
"currency": { "code": "USDC", "decimals": 2 }
},
"fundingPaymentInstructions": [],
"createdAt": "2025-10-01T10:00:00Z",
"updatedAt": "2025-10-03T15:05:00Z"
}
}Prompt To Fix With AI
This is a comment left during a code review. Path: mintlify/snippets/sending/cross-currency.mdx Line: 234-242 Comment: The webhook type was updated to `INTERNAL_ACCOUNT.BALANCE_UPDATED` but the payload example still uses the old flat structure (`accountId`, `oldBalance`, `newBalance` at root level). Every other file in this PR migrated to the new envelope format with a `data` wrapper, `id`, and `balance`. Developers copying this example will build against the wrong schema and their balance-tracking code will silently receive `undefined` for all fields. json { "id": "Webhook:019542f5-b3e7-1d02-0000-000000000026", "type": "INTERNAL_ACCOUNT.BALANCE_UPDATED", "timestamp": "2025-10-03T15:05:00Z", "data": { "id": "InternalAccount:019542f5-b3e7-1d02-0000-000000000025", "type": "INTERNAL_CRYPTO", "status": "ACTIVE", "balance": { "amount": 10000, "currency": { "code": "USDC", "decimals": 2 } }, "fundingPaymentInstructions": [], "createdAt": "2025-10-01T10:00:00Z", "updatedAt": "2025-10-03T15:05:00Z" } } ``` ``` How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
mintlify/snippets/sending/cross-currency.mdx:234-242
The webhook type was updated to `INTERNAL_ACCOUNT.BALANCE_UPDATED` but the payload example still uses the old flat structure (`accountId`, `oldBalance`, `newBalance` at root level). Every other file in this PR migrated to the new envelope format with a `data` wrapper, `id`, and `balance`. Developers copying this example will build against the wrong schema and their balance-tracking code will silently receive `undefined` for all fields.
```suggestion
```json
{
"id": "Webhook:019542f5-b3e7-1d02-0000-000000000026",
"type": "INTERNAL_ACCOUNT.BALANCE_UPDATED",
"timestamp": "2025-10-03T15:05:00Z",
"data": {
"id": "InternalAccount:019542f5-b3e7-1d02-0000-000000000025",
"type": "INTERNAL_CRYPTO",
"status": "ACTIVE",
"balance": {
"amount": 10000,
"currency": { "code": "USDC", "decimals": 2 }
},
"fundingPaymentInstructions": [],
"createdAt": "2025-10-01T10:00:00Z",
"updatedAt": "2025-10-03T15:05:00Z"
}
}
```
```
Reviews (1): Last reviewed commit: "Sync docs with recent OpenAPI schema cha..." | Re-trigger Greptile
Summary
Updates documentation to match recent OpenAPI schema changes from the following commits:
Documentation Updates
Internal Account Status
statusandtypefields to internal account JSON examplesINTERNAL_ACCOUNT.STATUS_UPDATEDwebhook documentation with example payloadPENDING,ACTIVE,CLOSED,FROZENWebhook Type Correction
ACCOUNT_STATUStype to correctINTERNAL_ACCOUNT.BALANCE_UPDATEDenum valueColombia (COP) Support
bankName,bankAccountType,documentType,documentNumberFiles Changed
mintlify/platform-overview/core-concepts/account-model.mdxmintlify/ramps/accounts/internal-accounts.mdxmintlify/ramps/platform-tools/sandbox-testing.mdxmintlify/ramps/platform-tools/webhooks.mdxmintlify/rewards/platform-tools/sandbox-testing.mdxmintlify/rewards/quickstart.mdxmintlify/snippets/depositing-funds.mdxmintlify/snippets/external-accounts.mdxmintlify/snippets/internal-accounts.mdxmintlify/snippets/sending/cross-currency.mdxTest plan
🤖 Generated with Claude Code