From 7bbed75fa042f6c4aeafb03ee80d3165093b97d6 Mon Sep 17 00:00:00 2001 From: Dhruv Pareek Date: Wed, 6 May 2026 16:44:21 -0700 Subject: [PATCH] Clarify embedded wallet account schema --- mintlify/openapi.yaml | 12 ++++++++---- openapi.yaml | 12 ++++++++---- .../schemas/customers/CustomerCreateRequest.yaml | 5 ++++- .../schemas/customers/CustomerUpdateRequest.yaml | 4 +++- .../schemas/customers/InternalAccountType.yaml | 4 ++-- .../paths/customers/customers_internal_accounts.yaml | 6 +++++- 6 files changed, 30 insertions(+), 13 deletions(-) diff --git a/mintlify/openapi.yaml b/mintlify/openapi.yaml index 573c5d77..531f8712 100644 --- a/mintlify/openapi.yaml +++ b/mintlify/openapi.yaml @@ -757,7 +757,11 @@ paths: 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 @@ -7813,7 +7817,7 @@ components: 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 @@ -7958,7 +7962,7 @@ components: 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 @@ -8010,7 +8014,7 @@ components: - `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. + - `EMBEDDED_WALLET`: A self-custodial Embedded Wallet provisioned for the customer based on platform currency configuration. Outbound transfers require a session signature produced by the customer's device. CurrencyAmount: type: object required: diff --git a/openapi.yaml b/openapi.yaml index 573c5d77..531f8712 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -757,7 +757,11 @@ paths: 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 @@ -7813,7 +7817,7 @@ components: 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 @@ -7958,7 +7962,7 @@ components: 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 @@ -8010,7 +8014,7 @@ components: - `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. + - `EMBEDDED_WALLET`: A self-custodial Embedded Wallet provisioned for the customer based on platform currency configuration. Outbound transfers require a session signature produced by the customer's device. CurrencyAmount: type: object required: diff --git a/openapi/components/schemas/customers/CustomerCreateRequest.yaml b/openapi/components/schemas/customers/CustomerCreateRequest.yaml index b43e36d5..24a9bf2c 100644 --- a/openapi/components/schemas/customers/CustomerCreateRequest.yaml +++ b/openapi/components/schemas/customers/CustomerCreateRequest.yaml @@ -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 diff --git a/openapi/components/schemas/customers/CustomerUpdateRequest.yaml b/openapi/components/schemas/customers/CustomerUpdateRequest.yaml index c17d2557..e1ec2745 100644 --- a/openapi/components/schemas/customers/CustomerUpdateRequest.yaml +++ b/openapi/components/schemas/customers/CustomerUpdateRequest.yaml @@ -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 diff --git a/openapi/components/schemas/customers/InternalAccountType.yaml b/openapi/components/schemas/customers/InternalAccountType.yaml index ce995975..a36e0301 100644 --- a/openapi/components/schemas/customers/InternalAccountType.yaml +++ b/openapi/components/schemas/customers/InternalAccountType.yaml @@ -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. diff --git a/openapi/paths/customers/customers_internal_accounts.yaml b/openapi/paths/customers/customers_internal_accounts.yaml index 12324737..59b753f9 100644 --- a/openapi/paths/customers/customers_internal_accounts.yaml +++ b/openapi/paths/customers/customers_internal_accounts.yaml @@ -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