chore: Sync account schemas - #387
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✱ Stainless preview buildsThis PR will update the kotlin openapi python typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-openapi studio · code · diff
✅ grid-kotlin studio · code · diff
✅ grid-typescript studio · code · diff
✅ grid-python studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
Greptile SummaryThis PR auto-syncs account schemas generated from VASP adapter field definitions in sparkcore. The changes include adding Confidence Score: 5/5Safe to merge — all findings are P2 documentation style issues that do not affect runtime validation or schema correctness. All schema changes are intentional syncs from sparkcore. The only finding is that DKK, EGP, and PKR example IBANs use a German prefix rather than the country-appropriate prefix, which is a cosmetic documentation concern with no impact on validation logic. openapi/components/schemas/common/DkkAccountInfoBase.yaml, EgpAccountInfoBase.yaml, PkrAccountInfoBase.yaml — example IBAN values use the wrong country prefix.
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/common/UsdAccountInfoBase.yaml | Breaking change: bankAccountType (CHECKING/SAVINGS) replaced with phoneNumber (now required), example block added |
| openapi/components/schemas/common/UsdAccountInfo.yaml | BANK_TRANSFER payment rail replaced with MOBILE_MONEY for USD accounts |
| openapi/components/schemas/common/CopAccountInfoBase.yaml | phoneNumber field removed entirely; bankName made required with length constraints; example added |
| openapi/components/schemas/common/CopBeneficiary.yaml | Required fields changed: countryOfResidence removed from required, documentNumber and documentType added as required |
| openapi/components/schemas/common/GtqAccountInfoBase.yaml | phoneNumber field replaced by bankAccountType (CHECKING/SAVINGS enum); bankName made required; example added |
| openapi/components/schemas/common/GtqBeneficiary.yaml | phoneNumber added as a required field |
| openapi/components/schemas/common/DkkAccountInfoBase.yaml | Adds example block — IBAN example value DE89370400440532013000 is a German IBAN, not a Danish one |
| openapi/components/schemas/common/EgpAccountInfoBase.yaml | Adds bankName as required field and example block — IBAN example value DE89370400440532013000 is a German IBAN, not an Egyptian one |
| openapi/components/schemas/common/PkrAccountInfoBase.yaml | Adds bankName as required field and example block — IBAN example value DE89370400440532013000 is a German IBAN, not a Pakistani one |
| openapi.yaml | Bundled OpenAPI spec updated in sync with all component YAML changes |
| mintlify/openapi.yaml | Mintlify bundled spec updated in sync with all component YAML changes |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[API Consumer] --> B{Currency}
B -->|USD| C[UsdAccountInfoBase\nrequires: accountNumber, routingNumber, phoneNumber\nrails: ACH, WIRE, RTP, FEDNOW, MOBILE_MONEY]
B -->|COP| D[CopAccountInfoBase\nrequires: bankName, accountNumber, bankAccountType\nrails: BANK_TRANSFER]
B -->|GTQ| E[GtqAccountInfoBase\nrequires: bankName, accountNumber, bankAccountType\nrails: BANK_TRANSFER]
B -->|EGP/GHS/PKR/BDT/JMD| F[*AccountInfoBase\nrequires: bankName added]
B -->|Other currencies| G[*AccountInfoBase\nexample blocks added]
D --> D1[CopBeneficiary\nrequires: documentNumber + documentType\nnot required: countryOfResidence]
E --> E1[GtqBeneficiary\nrequires: phoneNumber added]
Prompt To Fix All With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/DkkAccountInfoBase.yaml
Line: 22-25
Comment:
**Incorrect country prefix in IBAN examples**
Three schemas use `DE89370400440532013000` — a German IBAN — as their example value: `DkkAccountInfoBase` (Danish Krone), `EgpAccountInfoBase` (Egyptian Pound), and `PkrAccountInfoBase` (Pakistani Rupee). An IBAN example should carry the ISO country prefix that matches the currency's home country (`DK…` for Denmark, `EG…` for Egypt, `PK…` for Pakistan), otherwise it may mislead API consumers about what format to submit.
```suggestion
example:
accountType: DKK_ACCOUNT
iban: DK5000400440116243
swiftCode: DEUTDEFF
```
How can I resolve this? If you propose a fix, please make it concise.Reviews (1): Last reviewed commit: "chore: Sync account schemas" | Re-trigger Greptile
| maxLength: 11 | ||
| pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$ | ||
| example: | ||
| accountType: DKK_ACCOUNT |
There was a problem hiding this comment.
Incorrect country prefix in IBAN examples
Three schemas use DE89370400440532013000 — a German IBAN — as their example value: DkkAccountInfoBase (Danish Krone), EgpAccountInfoBase (Egyptian Pound), and PkrAccountInfoBase (Pakistani Rupee). An IBAN example should carry the ISO country prefix that matches the currency's home country (DK… for Denmark, EG… for Egypt, PK… for Pakistan), otherwise it may mislead API consumers about what format to submit.
| maxLength: 11 | |
| pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$ | |
| example: | |
| accountType: DKK_ACCOUNT | |
| example: | |
| accountType: DKK_ACCOUNT | |
| iban: DK5000400440116243 | |
| swiftCode: DEUTDEFF |
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/DkkAccountInfoBase.yaml
Line: 22-25
Comment:
**Incorrect country prefix in IBAN examples**
Three schemas use `DE89370400440532013000` — a German IBAN — as their example value: `DkkAccountInfoBase` (Danish Krone), `EgpAccountInfoBase` (Egyptian Pound), and `PkrAccountInfoBase` (Pakistani Rupee). An IBAN example should carry the ISO country prefix that matches the currency's home country (`DK…` for Denmark, `EG…` for Egypt, `PK…` for Pakistan), otherwise it may mislead API consumers about what format to submit.
```suggestion
example:
accountType: DKK_ACCOUNT
iban: DK5000400440116243
swiftCode: DEUTDEFF
```
How can I resolve this? If you propose a fix, please make it concise.|
Superseded by #388 |
Auto-synced account schemas.
These schemas are generated from VASP adapter field definitions in sparkcore.
Synced schemas:
common/— per-currency account info, beneficiary, and payment account schemascommon/PaymentInstructions.yaml— payment instructions oneOf (new currencies added)external_accounts/— per-currency external account schemas (reference common/)Please review the changes before merging.