Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions mintlify/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 19 additions & 2 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions openapi/components/schemas/common/CopAccountInfoBase.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ required:
- accountType
- accountNumber
- bankAccountType
- bankName
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Potentially breaking change: bankName added as required

Adding bankName to the required array is a breaking schema change for existing API consumers creating COP accounts — any client that doesn't already pass this field will now fail validation. If the backend enforcement is being introduced simultaneously, existing integrations will break without a migration period. Consider whether this should be phased in (e.g., optional first, then required) or whether existing clients have already been notified/updated.

Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/CopAccountInfoBase.yaml
Line: 6

Comment:
**Potentially breaking change: `bankName` added as required**

Adding `bankName` to the `required` array is a breaking schema change for existing API consumers creating COP accounts — any client that doesn't already pass this field will now fail validation. If the backend enforcement is being introduced simultaneously, existing integrations will break without a migration period. Consider whether this should be phased in (e.g., optional first, then required) or whether existing clients have already been notified/updated.

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a clean change, we have no existing Cop accounts

- phoneNumber
properties:
accountType:
Expand All @@ -20,6 +21,9 @@ properties:
enum:
- CHECKING
- SAVINGS
bankName:
type: string
description: The name of the bank
phoneNumber:
type: string
description: The phone number in international format
Expand Down
6 changes: 6 additions & 0 deletions openapi/components/schemas/common/CopBeneficiary.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,11 @@ properties:
countryOfResidence:
type: string
description: The country of residence of the beneficiary
documentType:
type: string
description: The type of identity document (e.g., national ID, passport)
documentNumber:
type: string
description: The identity document number
address:
$ref: ./Address.yaml
6 changes: 6 additions & 0 deletions openapi/components/schemas/common/UsdAccountInfoBase.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,9 @@ properties:
minLength: 9
maxLength: 9
pattern: ^[0-9]{9}$
bankAccountType:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could have sworn we have this somewhere, so I searched for "CHECKING" in the api and I saw that we only have it (incorrectly) in the example for external account creation as accountCategory. Can you update those examples too for both platform and customer external account creation?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can do!

type: string
description: The bank account type. Required for certain corridors (e.g., El Salvador).
enum:
- CHECKING
- SAVINGS
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ enum:
- ULTIMATE_INSTITUTION_COUNTRY
- IDENTIFIER
- BUSINESS_TYPE
- COMPANY_LEGAL_NAME
description: >-
Name of a type of field containing info about a platform's customer or
counterparty customer.
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/customers/customers_external_accounts.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ post:
accountType: USD_ACCOUNT
accountNumber: "12345678901"
routingNumber: "123456789"
accountCategory: CHECKING
bankAccountType: CHECKING
bankName: Chase Bank
platformAccountId: ext_acc_123456
beneficiary:
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/platform/platform_external_accounts.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ post:
accountType: USD_ACCOUNT
accountNumber: "12345678901"
routingNumber: "123456789"
accountCategory: CHECKING
bankAccountType: CHECKING
bankName: Chase Bank
platformAccountId: ext_acc_123456
beneficiary:
Expand Down
Loading