Skip to content

docs: use the real accountType values in external account examples #1026

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
JasonCWang wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: use the real accountType values in external account examples #1026

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
4 changes: 2 additions & 2 deletions mintlify/global-p2p/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ In this guide, the entities map as follows:
"platformAccountId": "mx_beneficiary_001",
"customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
"accountInfo": {
"accountType": "CLABE",
"accountType": "MXN_ACCOUNT",
"clabeNumber": "123456789012345678",
"bankName": "BBVA Mexico",
"beneficiary": {
Expand Down Expand Up @@ -115,7 +115,7 @@ In this guide, the entities map as follows:
"status": "ACTIVE",
"platformAccountId": "mx_beneficiary_001",
"accountInfo": {
"accountType": "CLABE",
"accountType": "MXN_ACCOUNT",
"clabeNumber": "123456789012345678",
"bankName": "BBVA Mexico",
"beneficiary": {
Expand Down
92 changes: 13 additions & 79 deletions mintlify/payouts-and-b2b/onboarding/configuring-customers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,20 +89,28 @@ Note that not all customer information can be updated. Particularly for non-regu

## Bank Account Information

The API supports various bank account formats based on country and funding type. There are two types of funding
mechanisms supported by Grid: an omnibus FBO (for benefit of) account owned by the platform, or direct customer-owned accounts. You must provide the correct format based on the customer's region and bank account type.
Register bank accounts and wallets with `POST /customers/external-accounts`. They are not part of the customer resource.

Set `accountInfo.accountType` to the currency code followed by `_ACCOUNT`, such as `USD_ACCOUNT`, `EUR_ACCOUNT`, or `MXN_ACCOUNT`. Wallets use their network name, such as `SPARK_WALLET`. Values such as `IBAN`, `SEPA`, `CLABE`, or `PIX` are rejected with `400 INVALID_INPUT`.

Most bank account types also require a `beneficiary` object. The required fields depend on the currency and the beneficiary type.

- [External Accounts](/payouts-and-b2b/depositing-funds/external-accounts) shows a full request for each region.
- [Required Fields by Corridor](/payouts-and-b2b/depositing-funds/required-fields) lists the fields each currency requires.
- [Add a new external account](/api-reference/external-accounts/add-a-new-external-account) documents the full schema for each account type.

### Optional Platform Account ID

All bank account types support an optional `platformAccountId` field that allows you to link bank accounts to your internal systems. This field can be any string that helps identify the account in your platform (e.g., database IDs, custom references, etc.).
All account types support an optional `platformAccountId` field that links the account to your internal systems. This field can be any string that identifies the account in your platform (e.g., database IDs, custom references, etc.).

Example with platform account ID:

```json
{
"accountType": "US_ACCOUNT",
"accountType": "USD_ACCOUNT",
"accountNumber": "123456789",
"routingNumber": "987654321",
"routingNumber": "021000021",
"bankAccountType": "CHECKING",
"bankName": "Chase Bank",
"platformAccountId": "chase_primary_1234"
}
Expand All @@ -115,80 +123,6 @@ Common use cases for `platformAccountId`:
- Maintaining consistency between the Grid API and your platform's account records
- Facilitating account reconciliation and reporting

<AccordionGroup>
<Accordion title="FBO Accounts">
FBO accounts are used when the platform has a single omnibus account that is used to fund all customers. Account details
must be provided manually at the platform level. For each customer, during you should simply provide:

```json
"bankAccountInfo": {
"accountType": "FBO",
"currencyCode": "USD" // or any other currency code supported by the Grid API
}
```

<Tip>
Please contact us to set up FBO account for a specific currency.
</Tip>
</Accordion>
<Accordion title="Mexico: CLABE">
```json
{
"accountType": "CLABE",
"clabeNumber": "123456789012345678",
"bankName": "Banco de M茅xico",
"platformAccountId": "banco_mx_primary_5678"
}
```
</Accordion>
<Accordion title="United States: ACH (Account and Routing Number)">
```json
{
"accountType": "US_ACCOUNT",
"accountNumber": "123456789",
"routingNumber": "987654321",
"accountCategory": "CHECKING",
"bankName": "Chase Bank",
"platformAccountId": "chase_checking_1234"
}
```
</Accordion>

<Accordion title="Brazil PIX">
```json
{
"accountType": "PIX",
"pixKey": "12345678901",
"pixKeyType": "CPF",
"platformAccountId": "pix_main_9012"
}
```

PIX key types can be one of: `CPF`, `CNPJ`, `PHONE`, `EMAIL`, or `RANDOM`.
</Accordion>

<Accordion title="India: UPI (Unified Payments Interface)">
```json
{
"accountType": "UPI",
"vpa": "somecustomer@okbank",
"platformAccountId": "upi_primary_1234"
}
```
</Accordion>

<Accordion title="International: IBAN">
```json
{
"accountType": "IBAN",
"iban": "DE89370400440532013000",
"bankName": "Deutsche Bank",
"platformAccountId": "deutsche_primary_3456"
}
```
</Accordion>
</AccordionGroup>

## Data Validation

The Grid API performs validation on all customer data. Common validation rules include:
Expand Down
4 changes: 2 additions & 2 deletions mintlify/payouts-and-b2b/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers/external-acco
"currency": "MXN",
"platformAccountId": "maria_garcia_account",
"accountInfo": {
"accountType": "CLABE",
"accountType": "MXN_ACCOUNT",
"clabeNumber": "123456789012345678",
"bankName": "BBVA Mexico",
"beneficiary": {
Expand Down Expand Up @@ -272,7 +272,7 @@ curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers/external-acco
"currency": "MXN",
"platformAccountId": "maria_garcia_account",
"accountInfo": {
"accountType": "CLABE",
"accountType": "MXN_ACCOUNT",
"clabeNumber": "123456789012345678",
"bankName": "BBVA Mexico",
"beneficiary": {
Expand Down
Loading