LIlight
v1 - Bank Accounts

Get bank accounts of the company

Returns all bank accounts of the company

get/v1/bank-accounts

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Response

default response

idstring uuid

Unique identifier for the bank account object

companyIdstring uuid

ID of the company

companyEntityIdstring uuid

ID of the entity

namestring

Bank account display name

type'PHYSICAL' | 'VIRTUAL'

Type of the bank account (physical or virtual)

  • PHYSICAL - A physical bank account
  • VIRTUAL - A virtual bank account

⚠️ This enum is not exhaustive; new values may be added in the future.

bankProvider'ABANCA' | 'ABN_AMRO' | 'AGRICULTURAL_BANK_OF_CHINA' | 'AIRWALLEX' | 'AKTIA_BANK' | 'ALANDS_BANKEN' | 'ANZ_GROUP' | 'ARBEJDERNES_LANDSBANK' | 'ARION_BANK' | 'BANCA_MARCH' | 'BANCA_NAZIONALE_DEL_LAVORO' | 'BANCO_BPM' | 'BANCO_BRADESCO' | 'BANCO_DO_BRASIL' | 'BANCO_SABADELL' | 'BANCO_SANTANDER' | 'BANK_NORWEGIAN' | 'BANK_OF_AMERICA' | 'BANK_OF_BEIJING' | 'BANK_OF_CHINA' | 'BANK_OF_COMMUNICATIONS' | 'BANK_OF_JIANGSU' | 'BANK_OF_MONTREAL' | 'BANK_OF_NINGBO' | 'BANK_OF_SHANGHAI' | 'BANK2' | 'BANKINTER' | 'BANQUE_PALATINE' | 'BARCLAYS' | 'BAYERNLB' | 'BBVA' | 'BCC_MILANO' | 'BN_BANK' | 'BNP_PARIBAS' | 'BNY_MELLON' | 'BOURSORAMA' | 'CAIXA_ECONOMICA_FEDERAL' | 'CAIXABANK' | 'CANADIAN_IMPERIAL_BANK_OF_COMMERCE' | 'CAPITAL_ONE' | 'CHARLES_SCHWAB' | 'CHINA_CITIC_BANK' | 'CHINA_CONSTRUCTION_BANK' | 'CHINA_EVERBRIGHT_BANK' | 'CHINA_GUANGFA_BANK' | 'CHINA_MERCHANTS_BANK' | 'CHINA_MINSHENG_BANK' | 'CHINA_ZHESHANG_BANK' | 'CITIGROUP' | 'COMMERZBANK' | 'COMMONWEALTH_BANK' | 'CREDIT_AGRICOLE' | 'CREDIT_DU_NORD' | 'CREDIT_MUTUEL' | 'CULTURA_SPAREBANK' | 'DANSKE_BANK' | 'DBS_GROUP' | 'DEUTSCHE_BANK' | 'DNB' | 'DNB_BANK' | 'DZ_BANK' | 'ERSTE_GROUP' | 'FELLOW_BANK' | 'GOLDMAN_SACHS' | 'GRASSHOPPER' | 'GROUPE_BPCE' | 'HANA_FINANCIAL' | 'HANDELSBANKEN' | 'HDFC_BANK' | 'HELABA' | 'HSBC' | 'HSBC_FRANCE' | 'HUAXIA_BANK' | 'HYPO' | 'IKANO_BANK' | 'INDUSTRIAL_AND_COMMERCIAL_BANK_OF_CHINA' | 'INDUSTRIAL_BANK' | 'INDUSTRIAL_BANK_OF_KOREA' | 'ING_DIBA' | 'ING_GROUP' | 'ING_SPAIN' | 'INSTABANK' | 'INTESA_SANPAOLO' | 'ISLANDSBANKI' | 'ITAU_UNIBANCO' | 'JAPAN_POST_BANK' | 'JPM_CHASE' | 'JYSKE' | 'KB_FINANCIAL_GROUP' | 'KBC_GROUP' | 'KFW_BANK' | 'KUTXABANK' | 'LA_BANQUE_POSTALE' | 'LANDKREDITT_BANK' | 'LANDESBANK_BADEN_WURTTEMBERG' | 'LANDESBANK_BADEN_WURTTEMBERG_LBBW' | 'LANDESBANK_BERLIN' | 'LANDSBANKINN' | 'LANSFORSAKRINGAR_BANK' | 'LLOYDS_BANK' | 'LLOYDS_BANKING_GROUP' | 'MERCURY' | 'MITSUBISHI_UFJ_FINANCIAL_GROUP' | 'MIZUHO_FINANCIAL_GROUP' | 'MONZO' | 'MORGAN_STANLEY' | 'NATIONAL_AUSTRALIA_BANK' | 'NATIONAL_BANK_OF_CANADA' | 'NATIONWIDE_BUILDING_SOCIETY' | 'NATWEST' | 'NATWEST_GROUP' | 'NOMURA_HOLDINGS' | 'NONGHYUP_BANK' | 'NORDEA' | 'NORDLB' | 'NORINCHUKIN_BANK' | 'NYKREDIT_BANK' | 'OCBC' | 'OP_BANK' | 'OTHER' | 'PARETO_BANK' | 'PAYPAL' | 'PING_AN_BANK' | 'PNC_FINANCIAL_SERVICES' | 'POP_PANKKI' | 'POSTAL_SAVINGS_BANK_OF_CHINA' | 'QATAR_NATIONAL_BANK' | 'RABOBANK' | 'RAIFFEISEN_GROUP' | 'RESONA_HOLDINGS' | 'REVOLUT' | 'RINGKJOBING_LANDBOBANK' | 'ROYAL_BANK_OF_CANADA' | 'S_PANKKI' | 'SANTANDER' | 'SANTANDER_UK' | 'SAXO_BANK' | 'SBANKEN' | 'SBERBANK_RUSSIA' | 'SCOTIABANK' | 'SEB' | 'SHANGHAI_PUDONG_DEVELOPMENT_BANK' | 'SHINHAN_FINANCIAL' | 'SMBC_GROUP' | 'SOCIETE_GENERALE' | 'SPAR_NORD_BANK' | 'STANDARD_CHARTERED' | 'STARLING_BANK' | 'STATE_BANK_OF_INDIA' | 'STOREBRAND_BANK' | 'STRIPE' | 'SUMITOMO_MITSUI_TRUST' | 'SVB' | 'SVENSKA_HANDELSBANKEN' | 'SWEDBANK' | 'SYDBANK' | 'TORONTO_DOMINION_BANK' | 'TRUIST_FINANCIAL' | 'TSB_BANK' | 'UBS' | 'UNICAJA_BANCO' | 'UNICREDIT' | 'UNICREDIT_BANK_HYPOVEREINSBANK' | 'UNITED_OVERSEAS_BANK' | 'US_BANCORP' | 'VEKSELBANKEN' | 'VIRGIN_MONEY' | 'WELLS_FARGO' | 'WESTPAC' | 'WISE' | 'WINTRUST_BANK' | 'WOORI_FINANCIAL' | 'YA_BANK' | 'ZKB'

Bank provider

⚠️ This enum is not exhaustive; new values may be added in the future.

paymentSchedulingEligibility'INTERNAL' | 'BANK_PROVIDER' | 'INELIGIBLE'

Payment scheduling eligibility for this bank account

  • INTERNAL - Eligible for payment scheduling via Light internal capabilities
  • BANK_PROVIDER - Eligible for payment scheduling via the bank provider
  • INELIGIBLE - Not eligible for payment scheduling

⚠️ This enum is not exhaustive; new values may be added in the future.

ibanstring nullable

IBAN

bicstring nullable

BIC / SWIFT code

domesticBankAccountNumberstring nullable

Domestic bank account number

domesticBankCodestring nullable

Domestic bank code / routing code

currencystring
bankCountry'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BU' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CP' | 'CR' | 'CS' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DG' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EA' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'EU' | 'EZ' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'FX' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'IC' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NT' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SF' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SU' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TP' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UK' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XI' | 'XU' | 'XK' | 'YE' | 'YT' | 'YU' | 'ZA' | 'ZM' | 'ZR' | 'ZW'

Bank country (ISO 3166-1 alpha-2)

⚠️ This enum is not exhaustive; new values may be added in the future.

bankCitystring nullable

Bank city

bankAddressstring nullable

Bank address

bankZipcodestring nullable

Bank ZIP / postal code

bankNamestring

Bank name

bankStatestring nullable

Bank state / region

ledgerAccountCodeinteger

Ledger account code linked to this bank account

createdAtstring date-time

Timestamp when the bank account was created

Example response

[
  {
    "currency": "USD"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.