Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Greptile SummaryThis PR expands the external accounts documentation with two new country examples (Philippines/PHP and United Kingdom/GBP), corresponding client-side validation snippets, and a new "Minimum required beneficiary fields" reference table. Key changes:
Issues found:
Confidence Score: 4/5Safe to merge after fixing the One P1 issue exists: the business-beneficiary row incorrectly documents mintlify/snippets/external-accounts.mdx — specifically the business beneficiary row in the new minimum required fields table (line 616)
|
| Filename | Overview |
|---|---|
| mintlify/snippets/external-accounts.mdx | Adds Philippines (PHP) and United Kingdom (GBP) account examples, validation snippets, and a new "Minimum required beneficiary fields" reference table. The business-beneficiary row in the table uses the wrong field path (legalName instead of businessInfo.legalName), which will mislead developers into sending malformed requests. Several countries covered in the tabs are absent from the table, and the Brazil taxId note lacks a matching code example. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Create External Account POST] --> B{Account Currency}
B -->|USD| C[US_ACCOUNT\nrequires: beneficiaryType, fullName]
B -->|MXN| D[CLABE\nrequires: beneficiaryType, fullName]
B -->|BRL| E[PIX\nrequires: beneficiaryType, fullName\n+ taxId at account level]
B -->|PHP| F[PHP_ACCOUNT NEW\nrequires: beneficiaryType, fullName\n+ paymentRails]
B -->|GBP| G[GBP_ACCOUNT NEW\nrequires: beneficiaryType, fullName, address\n+ sortCode + accountNumber\n+ paymentRails]
B -->|EUR| H[IBAN\nrequires: beneficiaryType, fullName, address]
B -->|Other| I[INR / NGN / ZAR\nKES / TZS / ZMW\nRWF / CAD\nrequirements not yet\ndocumented in table]
C & D & E & F & G & H --> J{Beneficiary Type}
J -->|INDIVIDUAL| K[fullName\n+ address if GBP or EUR]
J -->|BUSINESS| L[businessInfo.legalName\ntable incorrectly shows legalName]
K & L --> M{Account Status}
M -->|ACTIVE| N[Ready for payments]
M -->|PENDING| O[Awaiting verification]
M -->|UNDER_REVIEW| P[Additional review required]
M -->|INACTIVE| Q[Disabled]
Prompt To Fix All With AI
This is a comment left during a code review.
Path: mintlify/snippets/external-accounts.mdx
Line: 616
Comment:
**`legalName` field path is incorrect for business beneficiaries**
The table lists `legalName` as a required field directly on the beneficiary object, but the actual API structure (shown in the "Business beneficiaries" code example above at line ~580) nests it under `businessInfo.legalName`. A developer relying on this table would likely send:
```json
"beneficiary": {
"beneficiaryType": "BUSINESS",
"legalName": "Acme Corp"
}
```
…instead of the correct structure:
```json
"beneficiary": {
"beneficiaryType": "BUSINESS",
"businessInfo": {
"legalName": "Acme Corp"
}
}
```
This will likely result in an API error or silent field-drop for developers using this table as a reference.
```suggestion
| All countries | `beneficiaryType`, `businessInfo.legalName` | None (address optional) | Same requirements across all regions |
```
How can I resolve this? If you propose a fix, please make it concise.
---
This is a comment left during a code review.
Path: mintlify/snippets/external-accounts.mdx
Line: 603-610
Comment:
**Minimum required fields table is missing many supported countries**
The new table covers US, Mexico, Brazil, Philippines, and United Kingdom/Europe, but the tabs section documents many additional countries — India (INR), Nigeria (NGN), South Africa (ZAR), Kenya (KES), Tanzania (TZS), Zambia (ZMW), Rwanda (RWF), and Canada (CAD) — none of which appear here. Developers targeting those markets will search this table and find nothing, undercutting the table's value as a comprehensive reference.
Consider adding rows for the remaining countries, or adding a clarifying note (e.g. "Countries not listed above follow the same rules as US (USD)") so readers know what applies to omitted regions.
How can I resolve this? If you propose a fix, please make it concise.
---
This is a comment left during a code review.
Path: mintlify/snippets/external-accounts.mdx
Line: 607
Comment:
**Brazil `taxId` note conflicts with the PIX code example**
The table notes "`taxId` required at account level" for Brazil, but the existing PIX code example (around line 88) does not include a `taxId` field anywhere in the `accountInfo` payload. A developer reading this table note will look at the code example for guidance on where to place `taxId` and find nothing there.
Either update the PIX code example to include the `taxId` field in `accountInfo`, or clarify in the note precisely what the field name and location are (e.g. `accountInfo.taxId`).
How can I resolve this? If you propose a fix, please make it concise.Reviews (1): Last reviewed commit: "feat: adding more docs about minimum req..." | Re-trigger Greptile
|
|
||
| | Country | Required Fields | Required Address Fields | Notes | | ||
| | --- | --- | --- | --- | | ||
| | All countries | `beneficiaryType`, `legalName` | None (address optional) | Same requirements across all regions | |
There was a problem hiding this comment.
legalName field path is incorrect for business beneficiaries
The table lists legalName as a required field directly on the beneficiary object, but the actual API structure (shown in the "Business beneficiaries" code example above at line ~580) nests it under businessInfo.legalName. A developer relying on this table would likely send:
"beneficiary": {
"beneficiaryType": "BUSINESS",
"legalName": "Acme Corp"
}…instead of the correct structure:
"beneficiary": {
"beneficiaryType": "BUSINESS",
"businessInfo": {
"legalName": "Acme Corp"
}
}This will likely result in an API error or silent field-drop for developers using this table as a reference.
| | All countries | `beneficiaryType`, `legalName` | None (address optional) | Same requirements across all regions | | |
| | All countries | `beneficiaryType`, `businessInfo.legalName` | None (address optional) | Same requirements across all regions | |
Prompt To Fix With AI
This is a comment left during a code review.
Path: mintlify/snippets/external-accounts.mdx
Line: 616
Comment:
**`legalName` field path is incorrect for business beneficiaries**
The table lists `legalName` as a required field directly on the beneficiary object, but the actual API structure (shown in the "Business beneficiaries" code example above at line ~580) nests it under `businessInfo.legalName`. A developer relying on this table would likely send:
```json
"beneficiary": {
"beneficiaryType": "BUSINESS",
"legalName": "Acme Corp"
}
```
…instead of the correct structure:
```json
"beneficiary": {
"beneficiaryType": "BUSINESS",
"businessInfo": {
"legalName": "Acme Corp"
}
}
```
This will likely result in an API error or silent field-drop for developers using this table as a reference.
```suggestion
| All countries | `beneficiaryType`, `businessInfo.legalName` | None (address optional) | Same requirements across all regions |
```
How can I resolve this? If you propose a fix, please make it concise.| | Country | Required Fields | Required Address Fields | Notes | | ||
| | --- | --- | --- | --- | | ||
| | US (USD) | `beneficiaryType`, `fullName` | None (address optional) | | | ||
| | Mexico (MXN) | `beneficiaryType`, `fullName` | None (address optional) | | | ||
| | Brazil (BRL) | `beneficiaryType`, `fullName` | None (address optional) | `taxId` required at account level | | ||
| | Philippines (PHP) | `beneficiaryType`, `fullName` | None (address optional) | | | ||
| | United Kingdom (GBP) | `beneficiaryType`, `fullName`, `address` | `line1`, `postalCode`, `country` | Address is required | | ||
| | Europe (EUR) | `beneficiaryType`, `fullName`, `address` | `line1`, `postalCode`, `country` | Address is required | |
There was a problem hiding this comment.
Minimum required fields table is missing many supported countries
The new table covers US, Mexico, Brazil, Philippines, and United Kingdom/Europe, but the tabs section documents many additional countries — India (INR), Nigeria (NGN), South Africa (ZAR), Kenya (KES), Tanzania (TZS), Zambia (ZMW), Rwanda (RWF), and Canada (CAD) — none of which appear here. Developers targeting those markets will search this table and find nothing, undercutting the table's value as a comprehensive reference.
Consider adding rows for the remaining countries, or adding a clarifying note (e.g. "Countries not listed above follow the same rules as US (USD)") so readers know what applies to omitted regions.
Prompt To Fix With AI
This is a comment left during a code review.
Path: mintlify/snippets/external-accounts.mdx
Line: 603-610
Comment:
**Minimum required fields table is missing many supported countries**
The new table covers US, Mexico, Brazil, Philippines, and United Kingdom/Europe, but the tabs section documents many additional countries — India (INR), Nigeria (NGN), South Africa (ZAR), Kenya (KES), Tanzania (TZS), Zambia (ZMW), Rwanda (RWF), and Canada (CAD) — none of which appear here. Developers targeting those markets will search this table and find nothing, undercutting the table's value as a comprehensive reference.
Consider adding rows for the remaining countries, or adding a clarifying note (e.g. "Countries not listed above follow the same rules as US (USD)") so readers know what applies to omitted regions.
How can I resolve this? If you propose a fix, please make it concise.| | --- | --- | --- | --- | | ||
| | US (USD) | `beneficiaryType`, `fullName` | None (address optional) | | | ||
| | Mexico (MXN) | `beneficiaryType`, `fullName` | None (address optional) | | | ||
| | Brazil (BRL) | `beneficiaryType`, `fullName` | None (address optional) | `taxId` required at account level | |
There was a problem hiding this comment.
Brazil
taxId note conflicts with the PIX code example
The table notes "taxId required at account level" for Brazil, but the existing PIX code example (around line 88) does not include a taxId field anywhere in the accountInfo payload. A developer reading this table note will look at the code example for guidance on where to place taxId and find nothing there.
Either update the PIX code example to include the taxId field in accountInfo, or clarify in the note precisely what the field name and location are (e.g. accountInfo.taxId).
Prompt To Fix With AI
This is a comment left during a code review.
Path: mintlify/snippets/external-accounts.mdx
Line: 607
Comment:
**Brazil `taxId` note conflicts with the PIX code example**
The table notes "`taxId` required at account level" for Brazil, but the existing PIX code example (around line 88) does not include a `taxId` field anywhere in the `accountInfo` payload. A developer reading this table note will look at the code example for guidance on where to place `taxId` and find nothing there.
Either update the PIX code example to include the `taxId` field in `accountInfo`, or clarify in the note precisely what the field name and location are (e.g. `accountInfo.taxId`).
How can I resolve this? If you propose a fix, please make it concise.
No description provided.