Skip to content

chore: Sync account schemas#543

Closed
lightspark-copybara[bot] wants to merge 1 commit into
mainfrom
auto/sync-grid-schemas-20260603-170821
Closed

chore: Sync account schemas#543
lightspark-copybara[bot] wants to merge 1 commit into
mainfrom
auto/sync-grid-schemas-20260603-170821

Conversation

@lightspark-copybara
Copy link
Copy Markdown
Contributor

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 schemas
  • common/PaymentInstructions.yaml — payment instructions oneOf (new currencies added)
  • external_accounts/ — per-currency external account schemas (reference common/)

Please review the changes before merging.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
grid-flow-builder Ignored Ignored Preview Jun 3, 2026 5:08pm

Request Review

@github-actions github-actions Bot added the breaking-change Introduces a breaking change to the OpenAPI spec label Jun 3, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 3, 2026

⚠️ Breaking OpenAPI changes detected

This PR introduces breaking changes to openapi.yaml:

API Changelog 2025-10-13 vs. 2025-10-13

API Changes

POST /agents/me/external-accounts

  • ⚠️ added the new required request property allOf[subschema #1]/accountInfo/oneOf[subschema #11: GHS Account]/allOf[#/components/schemas/GhsAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #1]/accountInfo/oneOf[subschema #2: BDT Account]/allOf[#/components/schemas/BdtAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #1]/accountInfo/oneOf[subschema #6: COP Account]/allOf[#/components/schemas/CopAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #1]/accountInfo/oneOf[subschema #8: EGP Account]/allOf[#/components/schemas/EgpAccountInfoBase]/bankName
  • ⚠️ the request property allOf[subschema #1]/accountInfo/oneOf[subschema #24: PKR Account]/allOf[#/components/schemas/PkrAccountInfoBase]/bankName became required

POST /customers/external-accounts

  • ⚠️ added the new required request property allOf[subschema #1]/accountInfo/oneOf[subschema #11: GHS Account]/allOf[#/components/schemas/GhsAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #1]/accountInfo/oneOf[subschema #2: BDT Account]/allOf[#/components/schemas/BdtAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #1]/accountInfo/oneOf[subschema #6: COP Account]/allOf[#/components/schemas/CopAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #1]/accountInfo/oneOf[subschema #8: EGP Account]/allOf[#/components/schemas/EgpAccountInfoBase]/bankName
  • ⚠️ the request property allOf[subschema #1]/accountInfo/oneOf[subschema #24: PKR Account]/allOf[#/components/schemas/PkrAccountInfoBase]/bankName became required

POST /platform/external-accounts

  • ⚠️ added the new required request property accountInfo/oneOf[subschema #11: GHS Account]/allOf[#/components/schemas/GhsAccountInfoBase]/bankName
  • ⚠️ added the new required request property accountInfo/oneOf[subschema #2: BDT Account]/allOf[#/components/schemas/BdtAccountInfoBase]/bankName
  • ⚠️ added the new required request property accountInfo/oneOf[subschema #6: COP Account]/allOf[#/components/schemas/CopAccountInfoBase]/bankName
  • ⚠️ added the new required request property accountInfo/oneOf[subschema #8: EGP Account]/allOf[#/components/schemas/EgpAccountInfoBase]/bankName
  • ⚠️ the request property accountInfo/oneOf[subschema #24: PKR Account]/allOf[#/components/schemas/PkrAccountInfoBase]/bankName became required

POST webhook:agent-action

  • ⚠️ added the new required request property allOf[subschema #2]/data/quote/allOf[#/components/schemas/Quote]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #28: BDT Account]/allOf[#/components/schemas/BdtAccountInfo]/allOf[#/components/schemas/BdtAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #2]/data/quote/allOf[#/components/schemas/Quote]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #31: EGP Account]/allOf[#/components/schemas/EgpAccountInfo]/allOf[#/components/schemas/EgpAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #2]/data/quote/allOf[#/components/schemas/Quote]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #32: GHS Account]/allOf[#/components/schemas/GhsAccountInfo]/allOf[#/components/schemas/GhsAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #2]/data/transaction/allOf[#/components/schemas/TransactionOneOf]/oneOf[subschema #2: Outgoing Transaction]/allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #28: BDT Account]/allOf[#/components/schemas/BdtAccountInfo]/allOf[#/components/schemas/BdtAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #2]/data/transaction/allOf[#/components/schemas/TransactionOneOf]/oneOf[subschema #2: Outgoing Transaction]/allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #31: EGP Account]/allOf[#/components/schemas/EgpAccountInfo]/allOf[#/components/schemas/EgpAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #2]/data/transaction/allOf[#/components/schemas/TransactionOneOf]/oneOf[subschema #2: Outgoing Transaction]/allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #32: GHS Account]/allOf[#/components/schemas/GhsAccountInfo]/allOf[#/components/schemas/GhsAccountInfoBase]/bankName
  • ⚠️ the request property allOf[subschema #2]/data/quote/allOf[#/components/schemas/Quote]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #36: PKR Account]/allOf[#/components/schemas/PkrAccountInfo]/allOf[#/components/schemas/PkrAccountInfoBase]/bankName became required
  • ⚠️ the request property allOf[subschema #2]/data/transaction/allOf[#/components/schemas/TransactionOneOf]/oneOf[subschema #2: Outgoing Transaction]/allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #36: PKR Account]/allOf[#/components/schemas/PkrAccountInfo]/allOf[#/components/schemas/PkrAccountInfoBase]/bankName became required

POST webhook:internal-account-status

  • ⚠️ added the new required request property allOf[subschema #2]/data/fundingPaymentInstructions/items/accountOrWalletInfo/oneOf[subschema #28: BDT Account]/allOf[#/components/schemas/BdtAccountInfo]/allOf[#/components/schemas/BdtAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #2]/data/fundingPaymentInstructions/items/accountOrWalletInfo/oneOf[subschema #31: EGP Account]/allOf[#/components/schemas/EgpAccountInfo]/allOf[#/components/schemas/EgpAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #2]/data/fundingPaymentInstructions/items/accountOrWalletInfo/oneOf[subschema #32: GHS Account]/allOf[#/components/schemas/GhsAccountInfo]/allOf[#/components/schemas/GhsAccountInfoBase]/bankName
  • ⚠️ the request property allOf[subschema #2]/data/fundingPaymentInstructions/items/accountOrWalletInfo/oneOf[subschema #36: PKR Account]/allOf[#/components/schemas/PkrAccountInfo]/allOf[#/components/schemas/PkrAccountInfoBase]/bankName became required

POST webhook:outgoing-payment

  • ⚠️ added the new required request property allOf[subschema #2]/data/allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #28: BDT Account]/allOf[#/components/schemas/BdtAccountInfo]/allOf[#/components/schemas/BdtAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #2]/data/allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #31: EGP Account]/allOf[#/components/schemas/EgpAccountInfo]/allOf[#/components/schemas/EgpAccountInfoBase]/bankName
  • ⚠️ added the new required request property allOf[subschema #2]/data/allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #32: GHS Account]/allOf[#/components/schemas/GhsAccountInfo]/allOf[#/components/schemas/GhsAccountInfoBase]/bankName
  • ⚠️ the request property allOf[subschema #2]/data/allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #36: PKR Account]/allOf[#/components/schemas/PkrAccountInfo]/allOf[#/components/schemas/PkrAccountInfoBase]/bankName became required

Detected by oasdiff. This PR will need approval from an API reviewer before merge.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 3, 2026

✱ Stainless preview builds for grid

This PR will update the grid SDKs with the following commit messages.

cli

docs(api): document bankName requirement in external accounts account-info

csharp

feat(api): add bankName to BDT/COP/EGP/GHS/PKR, accountHolderName/bankAddress to USD accounts

go

fix(types): make bankName required in BDT/COP/EGP/GHS/PKR, add USD fields

kotlin

feat(api): add bankName to BDT/COP/EGP/GHS/PKR, accountHolderName/bankAddress to USD accounts

openapi

feat(api): add bankName to BDT/EGP/GHS/COP/PKR, accountHolderName/bankAddress to USD accounts

php

feat(api): add USD account fields, require bankName in BDT/COP/EGP/GHS/PKR models

python

feat(api): add required bankName to BDT/COP/EGP/GHS/PKR external accounts, optional USD fields

ruby

fix(types): make bank_name required in BDT/COP/EGP/GHS/PKR, add USD fields

typescript

feat(api): add required bankName to BDT/COP/EGP/GHS/PKR, optional fields to USD accounts

Edit this comment to update them. They will appear in their respective SDK's changelogs.

grid-openapi studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅

grid-ruby studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ✅test ✅

grid-kotlin studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ✅test ✅

grid-typescript studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ✅test ✅

npm install https://pkg.stainless.com/s/grid-typescript/dbcd9b6eda6c051bbc6f46ec734e51fd93c89423/dist.tar.gz
grid-python studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ❗test ❗

pip install https://pkg.stainless.com/s/grid-python/d3a869eb1dbc31115cb5e495ee4e2ec804c42e8a/grid-0.0.1-py3-none-any.whl
grid-csharp studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️build ❗lint ✅test ❗

grid-go studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ❗test ❗

go get github.com/stainless-sdks/grid-go@5676ec2251207c8cb61e70fdccaae7a94bbad4d0
grid-php studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅lint ✅test ✅

grid-cli studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️build ❗lint ❗test ❗


This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-06-03 17:15:36 UTC

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jun 3, 2026

Greptile Summary

This PR syncs account schema definitions from sparkcore, adding bankName as a globally required field to BDT, EGP, GHS, COP, and PKR account info schemas, and adding optional accountHolderName and bankAddress fields to the USD account info schema. Both the source YAML files and the two bundled specs (openapi.yaml and mintlify/openapi.yaml) are updated consistently.

  • BDT, EGP, GHS, COP: bankName added to required array and properties; per-rail descriptions updated to reflect it is needed for both BANK_TRANSFER and MOBILE_MONEY rails.
  • PKR: bankName was already defined in properties but is now promoted to required and moved to the top of the properties list; BANK_TRANSFER description updated accordingly.
  • USD: New optional accountHolderName (string) and bankAddress (allOf $ref to Address schema) fields added — non-breaking additions with no change to the required array.

Confidence Score: 5/5

Safe to merge — changes are additive schema documentation updates synced from sparkcore with no logic changes.

All five currency schemas that add bankName to required do so consistently, the descriptions match the schema constraints, and the PKR reorder is cosmetic only. The USD additions (accountHolderName, bankAddress) are entirely optional and non-breaking. Both bundled specs match the source YAML files.

No files require special attention; all changes are mechanical schema syncs.

Important Files Changed

Filename Overview
openapi/components/schemas/common/UsdAccountInfoBase.yaml Adds optional accountHolderName (string) and bankAddress (allOf $ref Address) fields to USD account info; both are non-required, non-breaking additions.
openapi/components/schemas/common/BdtAccountInfoBase.yaml Adds bankName to required array and properties; updates description to reflect bankName is now needed for both BANK_TRANSFER and MOBILE_MONEY rails.
openapi/components/schemas/common/PkrAccountInfoBase.yaml Moves bankName to the top of properties (after accountType) and adds it to the required array; updates BANK_TRANSFER description to include bankName; example reordered accordingly.
openapi.yaml Bundled OpenAPI spec updated to reflect all schema changes: bankName required in BDT/EGP/GHS/COP/PKR, accountHolderName and bankAddress added to USD.
mintlify/openapi.yaml Mintlify bundled spec updated with the same changes as openapi.yaml; appears to be an identical copy of the root bundled spec.

Class Diagram

%%{init: {'theme': 'neutral'}}%%
classDiagram
    class UsdAccountInfoBase {
        +string accountType (required)
        +string accountNumber (required)
        +string routingNumber (required)
        +string accountHolderName (NEW, optional)
        +Address bankAddress (NEW, optional)
    }
    class BdtAccountInfoBase {
        +string accountType (required)
        +string bankName (NEW, required)
        +string accountNumber
        +string branchCode
        +string swiftCode
        +string phoneNumber
    }
    class EgpAccountInfoBase {
        +string accountType (required)
        +string bankName (NEW, required)
        +string iban
        +string phoneNumber
    }
    class GhsAccountInfoBase {
        +string accountType (required)
        +string bankName (NEW, required)
        +string accountNumber
        +string phoneNumber
    }
    class CopAccountInfoBase {
        +string accountType (required)
        +string bankName (NEW, required)
        +string accountNumber
        +string bankAccountType
        +string phoneNumber
    }
    class PkrAccountInfoBase {
        +string accountType (required)
        +string bankName (NOW required, was optional)
        +string accountNumber
        +string iban
        +string phoneNumber
    }
    class Address {
        +string line1 (required)
        +string postalCode (required)
        +string country (required)
        +string line2
        +string city
        +string state
    }
    UsdAccountInfoBase --> Address : bankAddress
Loading

Reviews (1): Last reviewed commit: "chore: Sync account schemas" | Re-trigger Greptile

@lightspark-copybara
Copy link
Copy Markdown
Contributor Author

Superseded by #545

@lightspark-copybara lightspark-copybara Bot deleted the auto/sync-grid-schemas-20260603-170821 branch June 3, 2026 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking-change Introduces a breaking change to the OpenAPI spec

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants