Skip to content

Commit 6b7473c

Browse files
authored
feat: removing customerId from platformExternalAccount request (#218)
### TL;DR Added a new `PlatformExternalAccountCreateRequest` schema with a `platformAccountId` field and updated the platform external accounts endpoint to use this new schema instead of the generic `ExternalAccountCreateRequest`. ### What changed? - Created a new `PlatformExternalAccountCreateRequest` schema that includes a `platformAccountId` field for platform-specific account identification - Updated the platform external accounts POST endpoint to reference the new schema - The new schema maintains the same required fields (`currency` and `accountInfo`) as the original but adds the optional `platformAccountId` field ### How to test? - Test the platform external accounts creation endpoint with the new `platformAccountId` field - Verify that existing requests without `platformAccountId` still work as expected - Confirm that requests with `platformAccountId` properly store and reference the platform's identifier ### Why make this change? This change allows platforms to associate their own internal account identifiers with external accounts, enabling easier account management and reference within their own systems while maintaining compatibility with the existing API structure.
1 parent 7826a99 commit 6b7473c

4 files changed

Lines changed: 50 additions & 3 deletions

File tree

mintlify/openapi.yaml

Lines changed: 17 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi.yaml

Lines changed: 17 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
type: object
2+
required:
3+
- currency
4+
- accountInfo
5+
properties:
6+
currency:
7+
type: string
8+
description: The ISO 4217 currency code
9+
example: USD
10+
platformAccountId:
11+
type: string
12+
description: Your platform's identifier for the account in your system. This can be used to reference the account by your own identifier.
13+
example: ext_acc_123456
14+
accountInfo:
15+
$ref: ./ExternalAccountInfoOneOf.yaml

openapi/paths/platform/platform_external_accounts.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ post:
7979
content:
8080
application/json:
8181
schema:
82-
$ref: ../../components/schemas/external_accounts/ExternalAccountCreateRequest.yaml
82+
$ref: ../../components/schemas/external_accounts/PlatformExternalAccountCreateRequest.yaml
8383
examples:
8484
usBankAccount:
8585
summary: Create external US bank account

0 commit comments

Comments
 (0)