Skip to content

feat(openapi): add type discriminator to InternalAccount #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pengying merged 1 commit into from
Apr 23, 2026
Merged

feat(openapi): add type discriminator to InternalAccount #390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions mintlify/openapi.yaml
View file
Open in desktop

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

17 changes: 17 additions & 0 deletions openapi.yaml
View file
Open in desktop

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

3 changes: 3 additions & 0 deletions openapi/components/schemas/customers/InternalAccount.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
type: object
required:
- id
- type
- balance
- fundingPaymentInstructions
- createdAt
Expand All @@ -14,6 +15,8 @@ properties:
type: string
description: The ID of the customer associated with the internal account. If this field is empty, the internal account belongs to the platform.
example: Customer:019542f5-b3e7-1d02-0000-000000000001
type:
$ref: ./InternalAccountType.yaml
balance:
$ref: ../common/CurrencyAmount.yaml
fundingPaymentInstructions:
Expand Down
19 changes: 19 additions & 0 deletions openapi/components/schemas/customers/InternalAccountType.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
title: Internal Account Type
type: string
enum:
- INTERNAL_FIAT
- INTERNAL_CRYPTO
- EMBEDDED_WALLET
description: >-
Classification of an internal account.


- `INTERNAL_FIAT`: A Grid-managed fiat holding account (for example, the USD
holding account used as the source for Payouts flows).

- `INTERNAL_CRYPTO`: A Grid-managed crypto holding account denominated in a
stablecoin such as USDC.

- `EMBEDDED_WALLET`: A self-custodial Embedded Wallet provisioned for the
customer. Outbound transfers require a session signature produced by the
customer's device — see the Embedded Wallets guide.
Comment on lines +16 to +19
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot Apr 24, 2026

Choose a reason for hiding this comment

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

P2 Missing link in EMBEDDED_WALLET description

The description says "see the Embedded Wallets guide" but provides no URL or $ref to the actual guide. Integrators hitting this in the rendered docs won't know where to look for the session-signature flow details.

Suggested change
- `EMBEDDED_WALLET`: A self-custodial Embedded Wallet provisioned for the
customer. Outbound transfers require a session signature produced by the
customer's device — see the Embedded Wallets guide.
customer. Outbound transfers require a session signature produced by the
customer's device — see the [Embedded Wallets guide](/embedded-wallets).
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/components/schemas/customers/InternalAccountType.yaml
Line: 16-19

Comment:
**Missing link in `EMBEDDED_WALLET` description**

The description says "see the Embedded Wallets guide" but provides no URL or `$ref` to the actual guide. Integrators hitting this in the rendered docs won't know where to look for the session-signature flow details.

```suggestion
  customer. Outbound transfers require a session signature produced by the
  customer's device — see the [Embedded Wallets guide](/embedded-wallets).
```

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

Fix in Claude Code

9 changes: 9 additions & 0 deletions openapi/paths/internal-accounts/internal_accounts.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ get:
required: false
schema:
type: string
- name: type
in: query
description: >-
Filter by internal account type. Use `EMBEDDED_WALLET` to find the
self-custodial wallet provisioned for a customer, or `INTERNAL_FIAT` /
`INTERNAL_CRYPTO` for the platform-managed holding accounts.
required: false
schema:
$ref: ../../components/schemas/customers/InternalAccountType.yaml
- name: limit
in: query
description: Maximum number of results to return (default 20, max 100)
Expand Down
1 change: 1 addition & 0 deletions openapi/webhooks/internal-account-status.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ post:
data:
id: InternalAccount:019542f5-b3e7-1d02-0000-000000000005
customerId: Customer:019542f5-b3e7-1d02-0000-000000000001
type: INTERNAL_FIAT
balance:
amount: 10000
currency:
Expand Down
Loading