--- title: "List platform external accounts" method: GET path: "/platform/external-accounts" tags: ["External Accounts"] --- # List platform external accounts `GET /platform/external-accounts` Retrieve a list of all external accounts that belong to the platform, as opposed to an individual customer. These accounts are used for platform-wide operations such as receiving funds from external sources or managing platform-level payment destinations. ## Query parameters - `currency` string ## Response `200` Successful operation - object - `data` ExternalAccount[], required — List of external accounts matching the filter criteria - `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 - UsAccountExternalAccountInfo - `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 - `address` Address - … - `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) - BusinessBeneficiary - `address` Address - … - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — Legal name of the business - `registrationNumber` string — Business registration number - `taxId` string — Tax identification number - ClabeAccountExternalAccountInfo - `accountType` 'CLABE', required - `clabeNumber` string, required — 18-digit CLABE number (Mexican banking standard) - `beneficiary` union, required - IndividualBeneficiary - `address` Address - … - `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) - BusinessBeneficiary - `address` Address - … - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — Legal name of the business - `registrationNumber` string — Business registration number - `taxId` string — Tax identification number - PixAccountExternalAccountInfo - `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, required - IndividualBeneficiary - `address` Address - … - `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) - BusinessBeneficiary - `address` Address - … - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — Legal name of the business - `registrationNumber` string — Business registration number - `taxId` string — Tax identification number - IbanAccountExternalAccountInfo - `accountType` 'IBAN', required - `iban` string, required — International Bank Account Number - `swiftBic` string, required — SWIFT/BIC code (8 or 11 characters) - `beneficiary` union, required - IndividualBeneficiary - `address` Address - … - `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) - BusinessBeneficiary - `address` Address - … - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — Legal name of the business - `registrationNumber` string — Business registration number - `taxId` string — Tax identification number - UpiAccountExternalAccountInfo - `accountType` 'UPI', required - `vpa` string, required — Virtual Payment Address for UPI payments - `beneficiary` union, required - IndividualBeneficiary - `address` Address - … - `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) - BusinessBeneficiary - `address` Address - … - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — Legal name of the business - `registrationNumber` string — Business registration number - `taxId` string — Tax identification number - NgnAccountExternalAccountInfo - `accountType` 'NGN_ACCOUNT', required - `accountNumber` string, required — Nigerian bank account number - `bankName` string, required — Name of the bank - `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 - `beneficiary` union, required - IndividualBeneficiary - `address` Address - … - `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) - BusinessBeneficiary - `address` Address - … - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — Legal name of the business - `registrationNumber` string — Business registration number - `taxId` string — Tax identification number - CadAccountExternalAccountInfo - `accountType` 'CAD_ACCOUNT', required - `bankCode` string, required — Canadian financial institution number (3 digits) - `branchCode` string, required — Transit number identifying the branch (5 digits) - `accountNumber` string, required — Bank account number (7-12 digits) - `beneficiary` union, required - IndividualBeneficiary - `address` Address - … - `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) - BusinessBeneficiary - `address` Address - … - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — Legal name of the business - `registrationNumber` string — Business registration number - `taxId` string — Tax identification number - GbpAccountExternalAccountInfo - `accountType` 'GBP_ACCOUNT', required - `sortCode` string, required — UK bank sort code (6 digits, may include hyphens) - `accountNumber` string, required — UK bank account number (8 digits) - `beneficiary` union, required - IndividualBeneficiary - `address` Address - … - `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) - BusinessBeneficiary - `address` Address - … - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — Legal name of the business - `registrationNumber` string — Business registration number - `taxId` string — Tax identification number - PhpAccountExternalAccountInfo - `accountType` 'PHP_ACCOUNT', required - `bankName` string, required — Name of the beneficiary's bank - `accountNumber` string, required — Bank account number - `beneficiary` union, required - IndividualBeneficiary - `address` Address - … - `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) - BusinessBeneficiary - `address` Address - … - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — Legal name of the business - `registrationNumber` string — Business registration number - `taxId` string — Tax identification number - SgdAccountExternalAccountInfo - `accountType` 'SGD_ACCOUNT', required - `bankName` string, required — Name of the beneficiary's bank - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters) - `accountNumber` string, required — Bank account number - `beneficiary` union, required - IndividualBeneficiary - `address` Address - … - `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) - BusinessBeneficiary - `address` Address - … - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — Legal name of the business - `registrationNumber` string — Business registration number - `taxId` string — Tax identification number - SparkWalletExternalAccountInfo - `accountType` 'SPARK_WALLET', required - `address` string, required — Spark wallet address - LightningExternalAccountInfo — Lightning payment destination. Exactly one of `invoice`, `bolt12`, or `lightningAddress` must be provided. - `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. - SolanaWalletExternalAccountInfo - `accountType` 'SOLANA_WALLET', required - `address` string, required — Solana wallet address - TronWalletExternalAccountInfo - `accountType` 'TRON_WALLET', required - `address` string, required — Tron wallet address - PolygonWalletExternalAccountInfo - `accountType` 'POLYGON_WALLET', required - `address` string, required — Polygon eth wallet address - BaseWalletExternalAccountInfo - `accountType` 'BASE_WALLET', required - `address` string, required — Base eth wallet address ## Other responses - `400` — Bad request - Invalid parameters - `401` — Unauthorized - `500` — Internal service error ## Changes - **2026-02-13** `2055da1ed488` — 3 breaking, 15 info - the response's body type/format changed from ``/`` to `object`/`` for status `400` - the response's body type/format changed from ``/`` to `object`/`` for status `401` - the response's body type/format changed from ``/`` to `object`/`` for status `500` - removed `#/components/schemas/Error400_INVALID_INPUT, #/components/schemas/Error400_MISSING_MANDATORY_USER_INFO, #/components/schemas/Error400_INVITATION_ALREADY_CLAIMED, #/components/schemas/Error400_INVITATIONS_NOT_CONFIGURED, #/components/schemas/Error400_INVALID_UMA_ADDRESS, #/components/schemas/Error400_INVITATION_CANCELLED, #/components/schemas/Error400_QUOTE_REQUEST_FAILED, #/components/schemas/Error400_INVALID_PAYREQ_RESPONSE, #/components/schemas/Error400_INVALID_RECEIVER, #/components/schemas/Error400_PARSE_PAYREQ_RESPONSE_ERROR, #/components/schemas/Error400_CERT_CHAIN_INVALID, #/components/schemas/Error400_CERT_CHAIN_EXPIRED, #/components/schemas/Error400_INVALID_PUBKEY_FORMAT, #/components/schemas/Error400_MISSING_REQUIRED_UMA_PARAMETERS, #/components/schemas/Error400_SENDER_NOT_ACCEPTED, #/components/schemas/Error400_AMOUNT_OUT_OF_RANGE, #/components/schemas/Error400_INVALID_CURRENCY, #/components/schemas/Error400_INVALID_TIMESTAMP, #/components/schemas/Error400_INVALID_NONCE, #/components/schemas/Error400_INVALID_REQUEST_FORMAT, #/components/schemas/Error400_INVALID_BANK_ACCOUNT, #/components/schemas/Error400_SELF_PAYMENT, #/components/schemas/Error400_LOOKUP_REQUEST_FAILED, #/components/schemas/Error400_PARSE_LNURLP_RESPONSE_ERROR, #/components/schemas/Error400_INVALID_AMOUNT, #/components/schemas/Error400_WEBHOOK_ENDPOINT_NOT_SET, #/components/schemas/Error400_WEBHOOK_DELIVERY_ERROR` from the response body `oneOf` list for the response status `400` - …14 more - …earlier changes not shown [Full history](https://skmtc.dev/lightsparkdev/apis/grid-api/changes/platform/external-accounts/get.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/9ae8cc2fa307/schema)