---
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.
    - `beneficiaryVerificationStatus` 'MATCHED' | 'PARTIAL_MATCH' | 'NOT_MATCHED' | 'UNSUPPORTED' | 'CHECKED_BY_RECEIVING_FI' | 'PENDING' — The result of verifying the beneficiary name against the account holder name. | Status | Description | |--------|-------------| | `MATCHED` | The beneficiary name is an exact match | | `PARTIAL_MATCH` | The beneficiary name is a fuzzy match | | `NOT_MATCHED` | The beneficiary name does not match | | `UNSUPPORTED` | The payment rail does not support name verification | | `CHECKED_BY_RECEIVING_FI` | Verification is deferred to the receiving financial institution (e.g. ACH) | | `PENDING` | Verification is still in progress |
    - `beneficiaryVerifiedData` BeneficiaryVerifiedData
      - `fullName` string — The verified full name of the account holder as returned by the payment rail
    - `accountInfo` union, required
      - BrlExternalAccountInfo
        - `accountType` 'BRL_ACCOUNT', required
        - `paymentRails` string[], required
        - `pixKey` string, required — The PIX key of the bank
        - `pixKeyType` string, required — The type of PIX key of the bank
        - `taxId` string, required — The tax ID of the bank account
        - `beneficiary` union, required
          - BrlBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - CadExternalAccountInfo
        - `accountType` 'CAD_ACCOUNT', required
        - `paymentRails` string[], 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
          - CadBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - DkkExternalAccountInfo
        - `accountType` 'DKK_ACCOUNT', required
        - `paymentRails` string[], required
        - `iban` string, required — The IBAN of the bank
        - `swiftBic` string — The SWIFT BIC of the bank
        - `beneficiary` union, required
          - DkkBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - EurExternalAccountInfo
        - `accountType` 'EUR_ACCOUNT', required
        - `paymentRails` string[], required
        - `iban` string, required — The IBAN of the bank
        - `swiftBic` string — The SWIFT BIC of the bank
        - `beneficiary` union, required
          - EurBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - GbpExternalAccountInfo
        - `accountType` 'GBP_ACCOUNT', required
        - `paymentRails` string[], 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
          - GbpBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - HkdExternalAccountInfo
        - `accountType` 'HKD_ACCOUNT', required
        - `paymentRails` string[], required
        - `bankName` string, required — Name of the bank
        - `accountNumber` string, required — Hong Kong bank account number
        - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters)
        - `beneficiary` union, required
          - HkdBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - IdrExternalAccountInfo
        - `accountType` 'IDR_ACCOUNT', required
        - `paymentRails` string[], required
        - `accountNumber` string, required — Indonesian bank account number
        - `bankName` string, required — Name of the bank
        - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters)
        - `phoneNumber` string, required — Indonesian phone number for e-wallet payments
        - `beneficiary` union, required
          - IdrBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - InrExternalAccountInfo
        - `accountType` 'INR_ACCOUNT', required
        - `paymentRails` string[], required
        - `vpa` string, required — The VPA of the bank
        - `beneficiary` union, required
          - InrBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - KesExternalAccountInfo
        - `accountType` 'KES_ACCOUNT', required
        - `paymentRails` string[], required
        - `phoneNumber` string, required — Kenyan mobile money phone number
        - `provider` 'M-PESA', required — Mobile money provider
        - `beneficiary` union, required
          - KesBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - MxnExternalAccountInfo
        - `accountType` 'MXN_ACCOUNT', required
        - `paymentRails` string[], required
        - `clabeNumber` string, required — The CLABE number of the bank
        - `beneficiary` union, required
          - MxnBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - MyrExternalAccountInfo
        - `accountType` 'MYR_ACCOUNT', required
        - `paymentRails` string[], required
        - `bankName` string, required — Name of the bank
        - `accountNumber` string, required — Malaysian bank account number
        - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters)
        - `beneficiary` union, required
          - MyrBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - NgnExternalAccountInfo
        - `accountType` 'NGN_ACCOUNT', required
        - `paymentRails` string[], required
        - `accountNumber` string, required — Nigerian bank account number
        - `bankName` string, required — Name of the bank
        - `beneficiary` union, required
          - NgnBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - PhpExternalAccountInfo
        - `accountType` 'PHP_ACCOUNT', required
        - `paymentRails` string[], required
        - `bankName` string, required — Name of the beneficiary's bank
        - `accountNumber` string, required — Bank account number
        - `beneficiary` union, required
          - PhpBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - RwfExternalAccountInfo
        - `accountType` 'RWF_ACCOUNT', required
        - `paymentRails` string[], required
        - `phoneNumber` string, required — Rwandan mobile money phone number
        - `provider` 'MTN' | 'AIRTEL', required — Mobile money provider
        - `beneficiary` union, required
          - RwfBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - SgdExternalAccountInfo
        - `accountType` 'SGD_ACCOUNT', required
        - `paymentRails` string[], 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
          - SgdBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - ThbExternalAccountInfo
        - `accountType` 'THB_ACCOUNT', required
        - `paymentRails` string[], required
        - `bankName` string, required — Name of the bank
        - `accountNumber` string, required — Thai bank account number
        - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters)
        - `beneficiary` union, required
          - ThbBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - TzsExternalAccountInfo
        - `accountType` 'TZS_ACCOUNT', required
        - `paymentRails` string[], required
        - `phoneNumber` string, required — Tanzanian mobile money phone number
        - `provider` 'AIRTEL' | 'VODACOM', required — Mobile money provider
        - `beneficiary` union, required
          - TzsBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - UsdExternalAccountInfo
        - `accountType` 'USD_ACCOUNT', required
        - `paymentRails` string[], required
        - `accountNumber` string, required — The account number of the bank
        - `routingNumber` string, required — The routing number of the bank
        - `beneficiary` union, required
          - UsdBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string, required — The birth date of the beneficiary
            - `nationality` string, required — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - VndExternalAccountInfo
        - `accountType` 'VND_ACCOUNT', required
        - `paymentRails` string[], required
        - `bankName` string, required — Name of the bank
        - `accountNumber` string, required — Vietnamese bank account number
        - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters)
        - `beneficiary` union, required
          - VndBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - ZarExternalAccountInfo
        - `accountType` 'ZAR_ACCOUNT', required
        - `paymentRails` string[], required
        - `accountNumber` string, required — South African bank account number
        - `bankName` string, required — Name of the bank
        - `beneficiary` union, required
          - ZarBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - ZmwExternalAccountInfo
        - `accountType` 'ZMW_ACCOUNT', required
        - `paymentRails` string[], required
        - `phoneNumber` string, required — Zambian mobile money phone number
        - `provider` 'TNM' | 'AIRTEL' | 'ZAMTEL' | 'MTN', required — Mobile money provider
        - `beneficiary` union, required
          - ZmwBeneficiary
            - `beneficiaryType` 'INDIVIDUAL', required
            - `fullName` string, required — The full name of the beneficiary
            - `birthDate` string — The birth date of the beneficiary
            - `nationality` string — The nationality of the beneficiary
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `registrationNumber` string — The registration number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
          - BusinessBeneficiary
            - `beneficiaryType` 'BUSINESS', required
            - `legalName` string, required — The legal name of the business
            - `registrationNumber` string — The registration number of the business
            - `taxId` string — The tax identification number of the business
            - `email` string — The email of the beneficiary
            - `phoneNumber` string — The phone number of the beneficiary
            - `countryOfResidence` string — The country of residence of the beneficiary
            - `address` Address
              - …
      - 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-03-03** `efe0d983985f` — 21 breaking, 24 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`
  - added `#/components/schemas/KesExternalAccountInfo, #/components/schemas/RwfExternalAccountInfo, #/components/schemas/TzsExternalAccountInfo, #/components/schemas/ZarExternalAccountInfo, #/components/schemas/ZmwExternalAccountInfo` to the `data/items/allOf[subschema #1]/accountInfo` response property `oneOf` list for the response status `200`
  - …41 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/efe0d983985f/schema)
