---
title: "Add a new platform external account"
method: POST
path: "/platform/external-accounts"
tags: ["External Accounts"]
---

# Add a new platform external account

`POST /platform/external-accounts`

Register a new external bank account for the platform.

**Sandbox Testing:** In sandbox mode, use these account number patterns to test different transfer scenarios. These patterns should be used with the primary alias, address, or identifier of whatever account type you're testing. For example, the US account number, a CLABE, an IBAN, a spark wallet address, etc. The failure patterns are:
- Account numbers ending in **002**: Insufficient funds (transfer-in will fail)
- Account numbers ending in **003**: Account closed/invalid (transfers will fail)
- Account numbers ending in **004**: Transfer rejected (bank rejects the transfer)
- Account numbers ending in **005**: Timeout/delayed failure (stays pending ~30s, then fails)
- Any other account number: Success (transfers complete normally)

## Request body

- ExternalAccountCreateRequest
  - `customerId` string — The ID of the customer for whom to create the external account. If not provided, the external account will be created on behalf of the platform.
  - `currency` string, required — The ISO 4217 currency code
  - `platformAccountId` string — Your platform's identifier for the account in your system. This can be used to reference the account by your own identifier.
  - `defaultUmaDepositAccount` boolean — Whether to set the external account as the default UMA deposit account. When set to true, incoming payments to this customer's UMA address will be automatically deposited into this external account. False if not provided. Note that only one external account can be set as the default UMA deposit account for a customer, so if there is already a default UMA deposit account, this will override the existing default UMA deposit account. If there is no default UMA deposit account, incoming UMA payments will be deposited into the primary internal account for the customer.
  - `accountInfo` union, required
    - object
      - `accountType` 'US_ACCOUNT', required
      - `accountNumber` string, required — US bank account number
      - `routingNumber` string, required — ACH routing number (9 digits)
      - `accountCategory` 'CHECKING' | 'SAVINGS', required — Type of account (checking or savings)
      - `bankName` string — Name of the bank
      - `beneficiary` union, required
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - object
      - `accountType` 'CLABE', required
      - `clabeNumber` string, required — 18-digit CLABE number (Mexican banking standard)
      - `beneficiary` union
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - object
      - `accountType` 'PIX', required
      - `pixKey` string, required — PIX key for Brazilian instant payments
      - `pixKeyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM', required — Type of PIX key being used
      - `taxId` string, required — Tax ID of the account holder
      - `beneficiary` union
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - object
      - `accountType` 'IBAN', required
      - `iban` string, required — International Bank Account Number
      - `swiftBic` string, required — SWIFT/BIC code (8 or 11 characters)
      - `beneficiary` union
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - object
      - `accountType` 'UPI', required
      - `vpa` string, required — Virtual Payment Address for UPI payments
      - `beneficiary` union
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - object
      - `accountType` 'NGN_ACCOUNT', required
      - `accountNumber` string, required — Nigerian bank account number
      - `bankName` string, required — Name of the bank
      - `beneficiary` union, required
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
      - `purposeOfPayment` 'GIFT' | 'SELF' | 'GOODS_OR_SERVICES' | 'EDUCATION' | 'HEALTH_OR_MEDICAL' | 'REAL_ESTATE_PURCHASE' | 'LOAN_PAYMENT' | 'TAX_PAYMENT' | 'UTILITY_BILL' | 'DONATION' | 'TRAVEL' | 'OTHER', required — Purpose of payment
    - object
      - `accountType` 'SPARK_WALLET', required
      - `address` string, required — Spark wallet address
    - object
      - `accountType` 'LIGHTNING', required
      - `invoice` string — 1-time use lightning bolt11 invoice payout destination
      - `bolt12` string — A bolt12 offer which can be reused as a payment destination
      - `lightningAddress` string — A lightning address which can be used as a payment destination. Note that for UMA addresses, no external account is needed. You can use the UMA address directly as a destination.
    - object
      - `accountType` 'SOLANA_WALLET', required
      - `address` string, required — Solana wallet address
    - object
      - `accountType` 'TRON_WALLET', required
      - `address` string, required — Tron wallet address
    - object
      - `accountType` 'POLYGON_WALLET', required
      - `address` string, required — Polygon eth wallet address
    - object
      - `accountType` 'BASE_WALLET', required
      - `address` string, required — Base eth wallet address

## Response `201`

External account created successfully

- ExternalAccount
  - `id` string, required — The system generated identifier of this account
  - `customerId` string — The customer this account is tied to, or null if the account is on behalf of the platform.
  - `status` 'PENDING' | 'ACTIVE' | 'UNDER_REVIEW' | 'INACTIVE', required — Status of an external account
  - `platformAccountId` string — Optional platform-specific identifier for this account
  - `currency` string, required — The ISO 4217 currency code
  - `defaultUmaDepositAccount` boolean — Whether this account is the default UMA deposit account for the customer. If true, incoming UMA payments to this customer's UMA address will be automatically deposited into this account instead of the primary internal account. False if not provided. Note that at most, one external account can be set as the default UMA deposit account for a customer. If there is no default UMA deposit account, incoming UMA payments will be deposited into the primary internal account for the customer.
  - `accountInfo` union, required
    - object
      - `accountType` 'US_ACCOUNT', required
      - `accountNumber` string, required — US bank account number
      - `routingNumber` string, required — ACH routing number (9 digits)
      - `accountCategory` 'CHECKING' | 'SAVINGS', required — Type of account (checking or savings)
      - `bankName` string — Name of the bank
      - `beneficiary` union, required
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - object
      - `accountType` 'CLABE', required
      - `clabeNumber` string, required — 18-digit CLABE number (Mexican banking standard)
      - `beneficiary` union
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - object
      - `accountType` 'PIX', required
      - `pixKey` string, required — PIX key for Brazilian instant payments
      - `pixKeyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM', required — Type of PIX key being used
      - `taxId` string, required — Tax ID of the account holder
      - `beneficiary` union
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - object
      - `accountType` 'IBAN', required
      - `iban` string, required — International Bank Account Number
      - `swiftBic` string, required — SWIFT/BIC code (8 or 11 characters)
      - `beneficiary` union
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - object
      - `accountType` 'UPI', required
      - `vpa` string, required — Virtual Payment Address for UPI payments
      - `beneficiary` union
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - object
      - `accountType` 'NGN_ACCOUNT', required
      - `accountNumber` string, required — Nigerian bank account number
      - `bankName` string, required — Name of the bank
      - `beneficiary` union, required
        - IndividualBeneficiary
          - `beneficiaryType` 'INDIVIDUAL', required
          - `fullName` string, required — Individual's full name
          - `birthDate` string, date, required — Date of birth in ISO 8601 format (YYYY-MM-DD)
          - `nationality` string, required — Country code (ISO 3166-1 alpha-2)
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
        - BusinessBeneficiary
          - `beneficiaryType` 'BUSINESS', required
          - `legalName` string, required — Legal name of the business
          - `registrationNumber` string — Business registration number
          - `taxId` string — Tax identification number
          - `address` Address
            - `line1` string, required — Street address line 1
            - `line2` string — Street address line 2
            - `city` string — City
            - `state` string — State/Province/Region
            - `postalCode` string, required — Postal/ZIP code
            - `country` string, required — Country code (ISO 3166-1 alpha-2)
      - `purposeOfPayment` 'GIFT' | 'SELF' | 'GOODS_OR_SERVICES' | 'EDUCATION' | 'HEALTH_OR_MEDICAL' | 'REAL_ESTATE_PURCHASE' | 'LOAN_PAYMENT' | 'TAX_PAYMENT' | 'UTILITY_BILL' | 'DONATION' | 'TRAVEL' | 'OTHER', required — Purpose of payment
    - object
      - `accountType` 'SPARK_WALLET', required
      - `address` string, required — Spark wallet address
    - object
      - `accountType` 'LIGHTNING', required
      - `invoice` string — 1-time use lightning bolt11 invoice payout destination
      - `bolt12` string — A bolt12 offer which can be reused as a payment destination
      - `lightningAddress` string — A lightning address which can be used as a payment destination. Note that for UMA addresses, no external account is needed. You can use the UMA address directly as a destination.
    - object
      - `accountType` 'SOLANA_WALLET', required
      - `address` string, required — Solana wallet address
    - object
      - `accountType` 'TRON_WALLET', required
      - `address` string, required — Tron wallet address
    - object
      - `accountType` 'POLYGON_WALLET', required
      - `address` string, required — Polygon eth wallet address
    - object
      - `accountType` 'BASE_WALLET', required
      - `address` string, required — Base eth wallet address

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `409` — Conflict - External account already exists
- `500` — Internal service error

## Changes

- **2026-01-28** `9592dab2f96c` — 2 warning
  - removed the request property `allOf[subschema #1]/accountInfo/accountType`
  - removed the optional property `allOf[subschema #1]/accountInfo/accountType` from the response with the `201` status
- **2026-01-28** `60af1189794c` — 2 breaking, 2 info
  - the `allOf[subschema #1]/accountInfo` request property type/format changed from ``/`` to `object`/``
  - the `allOf[subschema #1]/accountInfo` response's property type/format changed from ``/`` to `object`/`` for status `201`
  - added the new optional request property `allOf[subschema #1]/accountInfo/accountType`
  - added the optional property `allOf[subschema #1]/accountInfo/accountType` to the response with the `201` status

[Change history](https://skmtc.dev/lightsparkdev/apis/grid-api/changes/platform/external-accounts/post.md)

---

[API](https://skmtc.dev/lightsparkdev/apis/grid-api.md) · [All operations](https://skmtc.dev/lightsparkdev/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lightsparkdev/grid-api/revisions/d1490309094a/schema)