Skip to content

Clarify embedded wallet account schema #446

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

Closed
DhruvPareek wants to merge 1 commit into from
Closed

Clarify embedded wallet account schema #446

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
12 changes: 8 additions & 4 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.

12 changes: 8 additions & 4 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.

5 changes: 4 additions & 1 deletion openapi/components/schemas/customers/CustomerCreateRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@ properties:
email:
type: string
format: email
description: Email address for the customer.
description: >-
Email address for the customer. Required when the customer will receive
an Embedded Wallet internal account, because the initial `EMAIL_OTP`
credential is tied to the customer email.
example: john.doe@example.com
umaAddress:
type: string
Expand Down
4 changes: 3 additions & 1 deletion openapi/components/schemas/customers/CustomerUpdateRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ properties:
email:
type: string
format: email
description: Email address for the customer.
description: >-
Email address for the customer. For Embedded Wallet customers, this is
the email used for `EMAIL_OTP` credentials.
example: john.doe@example.com
umaAddress:
type: string
Expand Down
4 changes: 2 additions & 2 deletions openapi/components/schemas/customers/InternalAccountType.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ description: >-
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.
customer based on platform currency configuration. Outbound transfers
require a session signature produced by the customer's device.
6 changes: 5 additions & 1 deletion openapi/paths/customers/customers_internal_accounts.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ get:
internal accounts that match the specified filters. If no filters are provided, returns all internal accounts
(paginated).

Internal accounts are created automatically when a customer is created based on the platform configuration.
Internal accounts are created automatically when a customer is created
based on the platform configuration. Platforms configured with an
Embedded Wallet currency create an internal account with type
`EMBEDDED_WALLET`; use the `type` filter to retrieve it for auth and
payment flows.
operationId: listCustomerInternalAccounts
tags:
- Internal Accounts
Expand Down
Loading