--- title: "Get agent external account by ID" method: GET path: "/agents/me/external-accounts/{externalAccountId}" tags: ["Agent Operations"] --- # Get agent external account by ID `GET /agents/me/external-accounts/{externalAccountId}` Retrieve an external account belonging to the authenticated agent's customer. Returns 404 if the account exists but belongs to a different customer. Requires the MANAGE_EXTERNAL_ACCOUNTS permission in the agent's policy. ## Response `200` Successful operation - ExternalAccount - `id` string, required — The system generated identifier of this account - `customerId` string — The customer this account is tied to, or null if the account is on behalf of the platform. - `status` 'PENDING' | 'ACTIVE' | 'UNDER_REVIEW' | 'INACTIVE', required — Status of an external account - `platformAccountId` string — Optional platform-specific identifier for this account - `ownershipType` 'FIRST_PARTY' | 'THIRD_PARTY' — Whether the external account belongs to the customer themselves (first party) or to someone else (third party) - `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 — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BdtExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: accountNumber, bankName - MOBILE_MONEY: bankName, phoneNumber - `accountType` 'BDT_ACCOUNT', required — Type of external account or wallet - `accountNumber` string — The account number of the bank - `bankName` string, required — The name 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BrlExternalAccountInfo - `accountType` 'BRL_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BwpExternalAccountInfo - `accountType` 'BWP_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - CadExternalAccountInfo - `accountType` 'CAD_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - CopExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: accountNumber, bankAccountType, bankName - MOBILE_MONEY: bankName, phoneNumber - `accountType` 'COP_ACCOUNT', required — Type of external account or wallet - `accountNumber` string — The account number of the bank - `bankAccountType` 'CHECKING' | 'SAVINGS' — The bank account type - `bankName` string, required — The name of the bank - `phoneNumber` string — The phone number in international format - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - `documentType` 'CC' | 'CE' | 'TI' | 'NIT' | 'PP' — Identity document type (Colombia) - `documentNumber` string — The identity document number - 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - DkkExternalAccountInfo - `accountType` 'DKK_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - EgpExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: bankName, iban - MOBILE_MONEY: bankName, phoneNumber - `accountType` 'EGP_ACCOUNT', required — Type of external account or wallet - `iban` string — Egyptian IBAN (29 characters, starting with EG) - `bankName` string, required — The name of the bank - `phoneNumber` string — The phone number in international format - `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 — The phone number of the beneficiary - `countryOfResidence` string — The country of residence of the beneficiary - `address` Address - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - EurExternalAccountInfo - `accountType` 'EUR_ACCOUNT', required — Type of external account or wallet - `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, required — The country of residence of the beneficiary - `address` Address - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - GbpExternalAccountInfo - `accountType` 'GBP_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - GhsExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: accountNumber, bankName - MOBILE_MONEY: bankName, phoneNumber - `accountType` 'GHS_ACCOUNT', required — Type of external account or wallet - `accountNumber` string — The account number of the bank - `bankName` string, required — The name 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - GtqExternalAccountInfo - `accountType` 'GTQ_ACCOUNT', required — Type of external account or wallet - `accountNumber` string, required — The account number of the bank - `bankAccountType` 'CHECKING' | 'SAVINGS', required — The bank account type - `bankName` string, required — The name of the beneficiary's bank - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - HkdExternalAccountInfo - `accountType` 'HKD_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - HtgExternalAccountInfo - `accountType` 'HTG_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - IdrExternalAccountInfo - `accountType` 'IDR_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - InrExternalAccountInfo — Required fields depend on the selected paymentRails: - NEFT: accountNumber, ifsc, rail - RTGS: accountNumber, ifsc, rail - UPI: vpa - `accountType` 'INR_ACCOUNT', required — Type of external account or wallet - `vpa` string — The UPI Virtual Payment Address - `accountNumber` string — Indian bank account number (9–18 digits) - `ifsc` string — The Indian Financial System Code (IFSC) of the beneficiary's bank branch (NEFT/RTGS) - `rail` string — The payment rail to route the payout over, for currencies that support more than one (e.g. NEFT or RTGS for INR). - `bankName` string — The name of the bank - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - JmdExternalAccountInfo - `accountType` 'JMD_ACCOUNT', required — Type of external account or wallet - `accountNumber` string, required — The account number of the bank - `branchCode` string, required — The branch code - `bankAccountType` 'CHECKING' | 'SAVINGS', required — The bank account type - `bankName` string, required — The name of the bank - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - KesExternalAccountInfo - `accountType` 'KES_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - MwkExternalAccountInfo - `accountType` 'MWK_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - MxnExternalAccountInfo - `accountType` 'MXN_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - MyrExternalAccountInfo - `accountType` 'MYR_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - NgnExternalAccountInfo - `accountType` 'NGN_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - PhpExternalAccountInfo - `accountType` 'PHP_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - PkrExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: accountNumber, bankName - MOBILE_MONEY: bankName, phoneNumber - `accountType` 'PKR_ACCOUNT', required — Type of external account or wallet - `bankName` string, required — The name of the bank - `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 - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - RwfExternalAccountInfo - `accountType` 'RWF_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - SgdExternalAccountInfo - `accountType` 'SGD_ACCOUNT', required — Type of external account or wallet - `bankName` string — Name of the beneficiary's bank. When omitted, resolved from swiftCode via the payout partner bank directory at account creation. - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - SlvExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: bankAccountType, accountNumber - MOBILE_MONEY: phoneNumber - `accountType` 'SLV_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - ThbExternalAccountInfo - `accountType` 'THB_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - TzsExternalAccountInfo - `accountType` 'TZS_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - UgxExternalAccountInfo - `accountType` 'UGX_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - UsdExternalAccountInfo - `accountType` 'USD_ACCOUNT', required — Type of external account or wallet - `accountNumber` string, required — The account number of the bank - `routingNumber` string, required — The ABA routing number - `bankName` string — The name of the financial institution holding the account. Optional on every rail, and recommended for wires, where it identifies the beneficiary's institution on the payment message. - `bankAccountType` 'CHECKING' | 'SAVINGS' — Whether the account is a checking or a savings account. Optional on every rail; when omitted, the account is treated as a checking account. - `intermediaryBankName` string — The name of the intermediary financial institution, for accounts reachable only through a correspondent bank. Used on the WIRE rail; ignored on ACH, RTP and FEDNOW. - `intermediaryRoutingNumber` string — The ABA routing number of the intermediary financial institution. Used on the WIRE rail; ignored on ACH, RTP and FEDNOW. - `fiToFiInformation` string — Bank-to-bank instructions carried alongside the payment. Used on the WIRE rail; ignored on ACH, RTP and FEDNOW. - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - VndExternalAccountInfo - `accountType` 'VND_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - XafExternalAccountInfo - `accountType` 'XAF_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - XofExternalAccountInfo - `accountType` 'XOF_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - ZarExternalAccountInfo - `accountType` 'ZAR_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - ZmwExternalAccountInfo - `accountType` 'ZMW_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - SwiftExternalAccountInfo - `accountType` 'SWIFT_ACCOUNT', required — Type of external account or wallet - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BaseWalletExternalAccountInfo - `accountType` 'BASE_WALLET', required — Type of external account or wallet - `address` string, required — Base eth wallet address - EthereumWalletExternalAccountInfo - `accountType` 'ETHEREUM_WALLET', required — Type of external account or wallet - `address` string, required — Ethereum L1 wallet address - LightningExternalAccountInfo — Lightning payment destination. Exactly one of `invoice`, `bolt12`, or `lightningAddress` must be provided. - `accountType` 'LIGHTNING', required — Type of external account or wallet - `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 — Type of external account or wallet - `address` string, required — Polygon eth wallet address - PlasmaWalletExternalAccountInfo - `accountType` 'PLASMA_WALLET', required — Type of external account or wallet - `address` string, required — Plasma wallet address - SolanaWalletExternalAccountInfo - `accountType` 'SOLANA_WALLET', required — Type of external account or wallet - `address` string, required — Solana wallet address - SparkWalletExternalAccountInfo - `accountType` 'SPARK_WALLET', required — Type of external account or wallet - `address` string, required — Spark wallet address - TronWalletExternalAccountInfo - `accountType` 'TRON_WALLET', required — Type of external account or wallet - `address` string, required — Tron wallet address - CnyExternalAccountInfo — Required fields depend on the selected paymentRails: - BANK_TRANSFER: accountNumber, bankName - MOBILE_MONEY: bankName, phoneNumber - `accountType` 'CNY_ACCOUNT', required — Type of external account or wallet - `accountNumber` string — The account number of the bank - `bankName` string, required — The name of the bank - `phoneNumber` string — The phone number in international format - `paymentRails` string[], required - `beneficiary` union, required - CnyBeneficiary - `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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) - BusinessBeneficiary - `beneficiaryType` 'BUSINESS', required - `legalName` string, required — 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 - `line1` string, required — Street address line 1 - `line2` string — Street address line 2 - `city` string — City - `state` string — State/Province/Region - `postalCode` string, required — Postal/ZIP code - `country` string, required — Country code (ISO 3166-1 alpha-2) ## Other responses - `401` — Unauthorized - `404` — External account not found - `500` — Internal service error --- [API](https://skmtc.net/stainless-api/apis/grid-api.md) · [All operations](https://skmtc.net/stainless-api/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stainless-api/grid-api/versions/151f2d9bad9c/schema)