From e9c5db537bc084f9ac7cb7ab8bb8fedf0001d538 Mon Sep 17 00:00:00 2001 From: Jason Wang Date: Thu, 17 Sep 2026 17:11:27 -0700 Subject: [PATCH] docs: use the real accountType values in external account examples The onboarding guide and both quickstarts showed accountType values such as IBAN and CLABE. The API accepts only the _ACCOUNT and wallet values, so these examples failed with 400 INVALID_INPUT. Replace the stale inline bank-account section with the canonical naming rule and links to the per-region examples, the required fields table, and the endpoint reference. Co-Authored-By: Claude Opus 5 (1M context) --- mintlify/global-p2p/quickstart.mdx | 4 +- .../onboarding/configuring-customers.mdx | 92 +++---------------- mintlify/payouts-and-b2b/quickstart.mdx | 4 +- 3 files changed, 17 insertions(+), 83 deletions(-) diff --git a/mintlify/global-p2p/quickstart.mdx b/mintlify/global-p2p/quickstart.mdx index 92f38cf8a..916995379 100644 --- a/mintlify/global-p2p/quickstart.mdx +++ b/mintlify/global-p2p/quickstart.mdx @@ -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": { @@ -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": { diff --git a/mintlify/payouts-and-b2b/onboarding/configuring-customers.mdx b/mintlify/payouts-and-b2b/onboarding/configuring-customers.mdx index 753a019c8..e83b6f9fb 100644 --- a/mintlify/payouts-and-b2b/onboarding/configuring-customers.mdx +++ b/mintlify/payouts-and-b2b/onboarding/configuring-customers.mdx @@ -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" } @@ -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 - - - 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 - } - ``` - - - Please contact us to set up FBO account for a specific currency. - - - - ```json - { - "accountType": "CLABE", - "clabeNumber": "123456789012345678", - "bankName": "Banco de México", - "platformAccountId": "banco_mx_primary_5678" - } - ``` - - - ```json - { - "accountType": "US_ACCOUNT", - "accountNumber": "123456789", - "routingNumber": "987654321", - "accountCategory": "CHECKING", - "bankName": "Chase Bank", - "platformAccountId": "chase_checking_1234" - } - ``` - - - - ```json - { - "accountType": "PIX", - "pixKey": "12345678901", - "pixKeyType": "CPF", - "platformAccountId": "pix_main_9012" - } - ``` - - PIX key types can be one of: `CPF`, `CNPJ`, `PHONE`, `EMAIL`, or `RANDOM`. - - - - ```json - { - "accountType": "UPI", - "vpa": "somecustomer@okbank", - "platformAccountId": "upi_primary_1234" - } - ``` - - - - ```json - { - "accountType": "IBAN", - "iban": "DE89370400440532013000", - "bankName": "Deutsche Bank", - "platformAccountId": "deutsche_primary_3456" - } - ``` - - - ## Data Validation The Grid API performs validation on all customer data. Common validation rules include: diff --git a/mintlify/payouts-and-b2b/quickstart.mdx b/mintlify/payouts-and-b2b/quickstart.mdx index 603678307..d7da43154 100644 --- a/mintlify/payouts-and-b2b/quickstart.mdx +++ b/mintlify/payouts-and-b2b/quickstart.mdx @@ -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": { @@ -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": {