--- 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 - `limit` integer - `cursor` string ## Response `200` Successful operation - ExternalAccountListResponse - `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 - AedExternalAccountInfo - `accountType` 'AED_ACCOUNT', required - `iban` string, required — UAE IBAN (23 characters, starting with AE) - `swiftCode` string — The SWIFT/BIC code of the bank - `paymentRails` string[], required - `beneficiary` union, required - AedBeneficiary - `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 - `countryOfResidence` string — The country of residence of the beneficiary - `address` Address, required - … - 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 - … - BdtExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: accountNumber - MOBILE_MONEY: phoneNumber - `accountType` 'BDT_ACCOUNT', required - `accountNumber` string — The account number of the bank - `branchCode` string — The branch code - `swiftCode` string — The SWIFT/BIC code of the bank - `phoneNumber` string — The phone number in international format - `paymentRails` string[], required - `beneficiary` union, required - BdtBeneficiary - `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 - `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 - … - BrlExternalAccountInfo - `accountType` 'BRL_ACCOUNT', required - `pixKey` string, required — The PIX key (email, phone, CPF, CNPJ, or random) - `pixKeyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM', required — The type of PIX key - `taxId` string, required — The tax ID (CPF or CNPJ) - `paymentRails` string[], required - `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 - `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 - … - BwpExternalAccountInfo - `accountType` 'BWP_ACCOUNT', required - `phoneNumber` string, required — The phone number in international format - `provider` string, required — The mobile money provider name - `paymentRails` string[], required - `beneficiary` union, required - BwpBeneficiary - `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 - `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 - `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) - `paymentRails` string[], required - `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 - … - CopExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: bankName, accountNumber, bankAccountType - MOBILE_MONEY: phoneNumber - `accountType` 'COP_ACCOUNT', required - `bankName` string — The name of the bank (BANK_TRANSFER only) - `accountNumber` string — The account number of the bank (BANK_TRANSFER only) - `bankAccountType` 'CHECKING' | 'SAVINGS' — The bank account type (BANK_TRANSFER only) - `phoneNumber` string — The phone number in international format (MOBILE_MONEY only — Nequi, Daviplata) - `paymentRails` string[], required - `beneficiary` union, required - CopBeneficiary - `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 - `countryOfResidence` string — The country of residence of the beneficiary - `address` Address - … - `documentType` 'CC' | 'CE' | 'TI' | 'NIT' | 'PP' — Identity document type — required by most Colombian banks. CC: Cédula de Ciudadanía, CE: Cédula de Extranjería, TI: Tarjeta de Identidad, NIT: Número de Identificación Tributaria, PP: Passport - `documentNumber` string — Identity document number — required by most Colombian banks - 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 - `iban` string, required — Danish IBAN (18 characters, starting with DK) - `swiftCode` string — The SWIFT/BIC code of the bank - `paymentRails` string[], required - `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 - `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 - … - EgpExternalAccountInfo - `accountType` 'EGP_ACCOUNT', required - `bankName` string, required — The name of the bank - `accountNumber` string, required — The account number of the bank - `iban` string — Egyptian IBAN (29 characters, starting with EG) - `swiftCode` string — The SWIFT/BIC code of the bank - `paymentRails` string[], required - `beneficiary` union, required - EgpBeneficiary - `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, required — The phone number of the beneficiary - `countryOfResidence` string, required — The country of residence of the beneficiary - `address` Address, required - … - 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 - `iban` string, required — The IBAN of the bank account - `swiftCode` string — The SWIFT/BIC code of the bank - `paymentRails` string[], required - `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 - `countryOfResidence` string — The country of residence of the beneficiary - `address` Address, required - … - 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 - `sortCode` string, required — The UK sort code - `accountNumber` string, required — UK bank account number (8 digits) - `paymentRails` string[], required - `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 - `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 - … - GhsExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: accountNumber - MOBILE_MONEY: phoneNumber - `accountType` 'GHS_ACCOUNT', required - `accountNumber` string — The account number of the bank - `phoneNumber` string — The phone number in international format - `paymentRails` string[], required - `beneficiary` union, required - GhsBeneficiary - `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 - `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 - … - GtqExternalAccountInfo - `accountType` 'GTQ_ACCOUNT', required - `accountNumber` string, required — The account number of the bank - `bankAccountType` 'CHECKING' | 'SAVINGS', required — The bank account type - `paymentRails` string[], required - `beneficiary` union, required - GtqBeneficiary - `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, required — The phone number of the beneficiary - `countryOfResidence` string, required — 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 - `bankName` string, required — The name of the bank - `accountNumber` string, required — Hong Kong bank account number - `swiftCode` string, required — The SWIFT/BIC code of the bank - `paymentRails` string[], required - `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 - `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 - … - HtgExternalAccountInfo - `accountType` 'HTG_ACCOUNT', required - `phoneNumber` string, required — The phone number in international format - `paymentRails` string[], required - `beneficiary` union, required - HtgBeneficiary - `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 - `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 - `bankName` string, required — The name of the bank - `accountNumber` string, required — Indonesian bank account number - `swiftCode` string, required — The SWIFT/BIC code of the bank - `phoneNumber` string, required — Indonesian phone number for e-wallet payments - `paymentRails` string[], required - `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 - `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 - `vpa` string, required — The UPI Virtual Payment Address - `paymentRails` string[], required - `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 - `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 - … - JmdExternalAccountInfo - `accountType` 'JMD_ACCOUNT', required - `accountNumber` string, required — The account number of the bank - `branchCode` string, required — The branch code - `bankAccountType` 'CHECKING' | 'SAVINGS', required — The bank account type - `paymentRails` string[], required - `beneficiary` union, required - JmdBeneficiary - `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, required — The phone number of the beneficiary - `countryOfResidence` string — The country of residence of the beneficiary - `address` Address, required - … - 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 - `phoneNumber` string, required — Kenyan mobile money phone number - `provider` string, required — The mobile money provider name - `paymentRails` string[], required - `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 - `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 - … - MwkExternalAccountInfo - `accountType` 'MWK_ACCOUNT', required - `phoneNumber` string, required — The phone number in international format - `provider` string, required — The mobile money provider name - `paymentRails` string[], required - `beneficiary` union, required - MwkBeneficiary - `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 - `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 - `clabeNumber` string, required — The CLABE number of the bank - `paymentRails` string[], required - `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 - `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 - `bankName` string, required — The name of the bank - `accountNumber` string, required — Malaysian bank account number - `swiftCode` string, required — The SWIFT/BIC code of the bank - `paymentRails` string[], required - `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 - `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 - `accountNumber` string, required — Nigerian bank account number - `bankName` string, required — The name of the bank - `paymentRails` string[], required - `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 - `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 - `bankName` string, required — Name of the beneficiary's bank - `accountNumber` string, required — Bank account number - `paymentRails` string[], required - `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 - `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 - … - PkrExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: accountNumber - MOBILE_MONEY: bankName, phoneNumber - `accountType` 'PKR_ACCOUNT', required - `accountNumber` string — The account number of the bank - `iban` string — Pakistani IBAN (24 characters, starting with PK) - `phoneNumber` string — The phone number in international format - `bankName` string — The name of the bank - `paymentRails` string[], required - `beneficiary` union, required - PkrBeneficiary - `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 - `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 - `phoneNumber` string, required — Rwandan mobile money phone number - `provider` string, required — The mobile money provider name - `paymentRails` string[], required - `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 - `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 - `bankName` string, required — Name of the beneficiary's bank - `accountNumber` string, required — Bank account number - `swiftCode` string, required — The SWIFT/BIC code of the bank - `paymentRails` string[], required - `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 - `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 - … - SlvExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: bankAccountType, accountNumber - MOBILE_MONEY: phoneNumber - `accountType` 'SLV_ACCOUNT', required - `bankName` string — The name of the bank (BANK_TRANSFER only) - `accountNumber` string — The account number of the bank (BANK_TRANSFER only) - `bankAccountType` 'CHECKING' | 'SAVINGS' — The bank account type (BANK_TRANSFER only) - `phoneNumber` string — The phone number in international format (MOBILE_MONEY only — e.g. Tigo Money) - `paymentRails` string[], required - `beneficiary` union, required - SlvBeneficiary - `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 - `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 - `bankName` string, required — The name of the bank - `accountNumber` string, required — Thai bank account number - `swiftCode` string, required — The SWIFT/BIC code of the bank - `paymentRails` string[], required - `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 - `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 - `phoneNumber` string, required — Tanzanian mobile money phone number - `provider` string, required — The mobile money provider name - `paymentRails` string[], required - `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 - `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 - … - UgxExternalAccountInfo - `accountType` 'UGX_ACCOUNT', required - `phoneNumber` string, required — The phone number in international format - `provider` string, required — The mobile money provider name - `paymentRails` string[], required - `beneficiary` union, required - UgxBeneficiary - `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 - `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 - `accountNumber` string, required — The account number of the bank - `routingNumber` string, required — The ABA routing number - `paymentRails` string[], required - `beneficiary` union, required - UsdBeneficiary - `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 - `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 - `bankName` string, required — The name of the bank - `accountNumber` string, required — Vietnamese bank account number - `swiftCode` string, required — The SWIFT/BIC code of the bank - `paymentRails` string[], required - `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 - `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 - … - XafExternalAccountInfo - `accountType` 'XAF_ACCOUNT', required - `phoneNumber` string, required — The phone number in international format - `provider` string, required — The mobile money provider name - `region` 'CM' | 'CG', required — Country code within the Central African CFA franc zone - `paymentRails` string[], required - `beneficiary` union, required - XafBeneficiary - `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 - `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 - … - XofExternalAccountInfo - `accountType` 'XOF_ACCOUNT', required - `phoneNumber` string, required — The phone number in international format - `provider` string, required — The mobile money provider name - `region` 'BJ' | 'CI' | 'SN' | 'TG', required — Country code within the West African CFA franc zone - `paymentRails` string[], required - `beneficiary` union, required - XofBeneficiary - `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 - `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 - `accountNumber` string, required — South African bank account number - `bankName` string, required — The name of the bank - `paymentRails` string[], required - `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 - `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 - `phoneNumber` string, required — Zambian mobile money phone number - `provider` string, required — The mobile money provider name - `paymentRails` string[], required - `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 - `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 - … - SwiftExternalAccountInfo - `accountType` 'SWIFT_ACCOUNT', required - `country` string, required — The ISO 3166-1 alpha-2 country code of the bank account - `swiftCode` string, required — The SWIFT/BIC code of the bank - `bankName` string, required — The name of the bank - `accountNumber` string — The bank account number. Required for most corridors. Use iban instead for IBAN-only corridors (e.g. BR, GB). - `iban` string — The IBAN of the bank account. Required for IBAN-only corridors (e.g. BR, GB). Use accountNumber for all other corridors. - `paymentRails` string[], required - `beneficiary` union, required - SwiftBeneficiary - `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 - `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 - … - BaseWalletExternalAccountInfo - `accountType` 'BASE_WALLET', required - `address` string, required — Base eth wallet address - EthereumWalletExternalAccountInfo - `accountType` 'ETHEREUM_WALLET', required - `address` string, required — Ethereum L1 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. - PolygonWalletExternalAccountInfo - `accountType` 'POLYGON_WALLET', required - `address` string, required — Polygon eth wallet address - SolanaWalletExternalAccountInfo - `accountType` 'SOLANA_WALLET', required - `address` string, required — Solana wallet address - SparkWalletExternalAccountInfo - `accountType` 'SPARK_WALLET', required - `address` string, required — Spark wallet address - TronWalletExternalAccountInfo - `accountType` 'TRON_WALLET', required - `address` string, required — Tron wallet address - `hasMore` boolean, required — Indicates if more results are available beyond this page - `nextCursor` string — Cursor to retrieve the next page of results (only present if hasMore is true) - `totalCount` integer — Total number of external accounts matching the criteria (excluding pagination) ## Other responses - `400` — Bad request - Invalid parameters - `401` — Unauthorized - `500` — Internal service error --- [API](https://skmtc.net/lightsparkdev/apis/grid-api.md) · [All operations](https://skmtc.net/lightsparkdev/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightsparkdev/grid-api/versions/d0bce562bffd/schema)