Skip to content

docs: state the accountType rule and beneficiary requirements on the create endpoint #1027

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

Draft
JasonCWang wants to merge 1 commit into
base: jw/docs-external-account-type-values
Choose a base branch
from
Draft

docs: state the accountType rule and beneficiary requirements on the create endpoint #1027

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
37 changes: 35 additions & 2 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.

37 changes: 35 additions & 2 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.

38 changes: 35 additions & 3 deletions openapi/paths/customers/customers_external_accounts.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,21 @@ get:

post:
summary: Add a new external account
description: >-
Register a new external bank account for a customer.
description: |
Register a new external bank account or wallet for a customer.

Set `accountInfo.accountType` to the currency code followed by `_ACCOUNT`
(`EUR_ACCOUNT`, `USD_ACCOUNT`, `MXN_ACCOUNT`, ...) or to a wallet type
(`SPARK_WALLET`, `LIGHTNING`, ...). Values such as `IBAN`, `SEPA`, or
`CLABE` are rejected with `400 INVALID_INPUT`.

Most bank account types require a `beneficiary` object. Its required fields
depend on the currency and on `beneficiaryType`. For example, a EUR account
needs `beneficiaryType`, `fullName`, and `countryOfResidence`, and an
`address` (when given) needs `line1`, `postalCode`, and `country`.
See [Required Fields by Corridor](/payouts-and-b2b/depositing-funds/required-fields)
for every currency, and the [External Accounts](/payouts-and-b2b/depositing-funds/external-accounts)
guide for a full request per region.
operationId: createCustomerExternalAccount
tags:
- External Accounts
Expand All @@ -86,13 +99,13 @@ post:
value:
customerId: Customer:019542f5-b3e7-1d02-0000-000000000001
currency: USD
platformAccountId: ext_acc_123456
accountInfo:
accountType: USD_ACCOUNT
accountNumber: "12345678901"
routingNumber: "123456789"
bankAccountType: CHECKING
bankName: Chase Bank
platformAccountId: ext_acc_123456
beneficiary:
beneficiaryType: INDIVIDUAL
fullName: John Doe
Expand All @@ -104,6 +117,25 @@ post:
state: CA
postalCode: "94105"
country: US
eurBankAccount:
summary: Create external EUR bank account (SEPA)
value:
customerId: Customer:019542f5-b3e7-1d02-0000-000000000001
currency: EUR
platformAccountId: ext_acc_eur_123456
accountInfo:
accountType: EUR_ACCOUNT
iban: DE89370400440532013000
bankName: Deutsche Bank
beneficiary:
beneficiaryType: INDIVIDUAL
fullName: Hans Schmidt
countryOfResidence: DE
address:
line1: Hauptstraße 789
city: Berlin
postalCode: "10115"
country: DE
sparkWallet:
summary: Create external Spark wallet
value:
Expand Down
Loading