List platform external accounts

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/platform/external-accounts \
  --header 'Authorization: Basic <encoded-value>'

{
  "accounts": [
    {
      "id": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
      "status": "ACTIVE",
      "currency": "USD",
      "accountInfo": {
        "accountType": "US_ACCOUNT",
        "accountNumber": "123456789",
        "routingNumber": "987654321",
        "accountCategory": "CHECKING",
        "beneficiary": {
          "beneficiaryType": "INDIVIDUAL",
          "fullName": "John Michael Doe",
          "birthDate": "1990-01-15",
          "nationality": "US",
          "address": {
            "line1": "123 Main Street",
            "postalCode": "94105",
            "country": "US",
            "line2": "Apt 4B",
            "city": "San Francisco",
            "state": "CA"
          }
        },
        "bankName": "Chase Bank"
      },
      "customerId": "Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7",
      "platformAccountId": "acc_123456789",
      "defaultUmaDepositAccount": false
    }
  ]
}

GET

platform

external-accounts

List platform external accounts

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/platform/external-accounts \
  --header 'Authorization: Basic <encoded-value>'

{
  "accounts": [
    {
      "id": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
      "status": "ACTIVE",
      "currency": "USD",
      "accountInfo": {
        "accountType": "US_ACCOUNT",
        "accountNumber": "123456789",
        "routingNumber": "987654321",
        "accountCategory": "CHECKING",
        "beneficiary": {
          "beneficiaryType": "INDIVIDUAL",
          "fullName": "John Michael Doe",
          "birthDate": "1990-01-15",
          "nationality": "US",
          "address": {
            "line1": "123 Main Street",
            "postalCode": "94105",
            "country": "US",
            "line2": "Apt 4B",
            "city": "San Francisco",
            "state": "CA"
          }
        },
        "bankName": "Chase Bank"
      },
      "customerId": "Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7",
      "platformAccountId": "acc_123456789",
      "defaultUmaDepositAccount": false
    }
  ]
}

Authorizations

Authorization

string

header

required

API token authentication using format <api token id>:<api client secret>

Query Parameters

currency

string

Filter by currency code

Response

Successful operation

accounts

object[]

required

List of external accounts matching the filter criteria

Show child attributes

accounts.id

string

required

The system generated identifier of this account

Example:

"ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"

accounts.status

enum<string>

required

Status of the external account

Available options:

PENDING,

ACTIVE,

UNDER_REVIEW,

INACTIVE

Example:

"ACTIVE"

accounts.currency

string

required

The ISO 4217 currency code

Example:

"USD"

accounts.accountInfo

US Account · object

required

US Account
CLABE Account
PIX Account
IBAN Account
UPI Account
NGN Account
Spark Wallet
Lightning
Lightning
Lightning
Solana Wallet
Tron Wallet
Polygon Wallet
Base Wallet

Show child attributes

accounts.accountInfo.accountType

enum<string>

required

Available options:

US_ACCOUNT

Example:

"US_ACCOUNT"

accounts.accountInfo.accountNumber

string

required

US bank account number

Example:

"123456789"

accounts.accountInfo.routingNumber

string

required

ACH routing number (9 digits)

Required string length: 9

Example:

"987654321"

accounts.accountInfo.accountCategory

enum<string>

required

Type of account (checking or savings)

Available options:

CHECKING,

SAVINGS

Example:

"CHECKING"

accounts.accountInfo.beneficiary

object

required

Option 1
Option 2

Show child attributes

accounts.accountInfo.beneficiary.beneficiaryType

enum<string>

required

Available options:

INDIVIDUAL

Example:

"INDIVIDUAL"

accounts.accountInfo.beneficiary.fullName

string

required

Individual's full name

Example:

"John Michael Doe"

accounts.accountInfo.beneficiary.birthDate

string<date>

required

Date of birth in ISO 8601 format (YYYY-MM-DD)

Example:

"1990-01-15"

accounts.accountInfo.beneficiary.nationality

string

required

Country code (ISO 3166-1 alpha-2)

Example:

"US"

accounts.accountInfo.beneficiary.address

object

Show child attributes

accounts.accountInfo.beneficiary.address.line1

string

required

Street address line 1

Example:

"123 Main Street"

accounts.accountInfo.beneficiary.address.postalCode

string

required

Postal/ZIP code

Example:

"94105"

accounts.accountInfo.beneficiary.address.country

string

required

Country code (ISO 3166-1 alpha-2)

Example:

"US"

accounts.accountInfo.beneficiary.address.line2

string

Street address line 2

Example:

"Apt 4B"

accounts.accountInfo.beneficiary.address.city

string

City

Example:

"San Francisco"

accounts.accountInfo.beneficiary.address.state

string

State/Province/Region

Example:

"CA"

accounts.accountInfo.bankName

string

Name of the bank

Example:

"Chase Bank"

accounts.customerId

string

The customer this account is tied to, or null if the account is on behalf of the platform.

Example:

"Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7"

accounts.platformAccountId

string

Optional platform-specific identifier for this account

Example:

"acc_123456789"

accounts.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.

Example:

false

Add a new external account Add a new platform external account

⌘I

Using the API

API documentation

List platform external accounts

Authorizations

Query Parameters

Response