Skip to main content
GET
/
platform
/
external-accounts
cURL
curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/platform/external-accounts \
  --header 'Authorization: Basic <encoded-value>'
import LightsparkGrid from '@lightsparkdev/grid';

const client = new LightsparkGrid({
  username: process.env['GRID_CLIENT_ID'], // This is the default and can be omitted
  password: process.env['GRID_CLIENT_SECRET'], // This is the default and can be omitted
});

const externalAccounts = await client.platform.externalAccounts.list();

console.log(externalAccounts.data);
package com.lightspark.grid.example

import com.lightspark.grid.client.LightsparkGridClient
import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient
import com.lightspark.grid.models.platform.externalaccounts.ExternalAccountListParams
import com.lightspark.grid.models.platform.externalaccounts.ExternalAccountListResponse

fun main() {
    val client: LightsparkGridClient = LightsparkGridOkHttpClient.fromEnv()

    val externalAccounts: ExternalAccountListResponse = client.platform().externalAccounts().list()
}
{
  "data": [
    {
      "id": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
      "status": "ACTIVE",
      "currency": "USD",
      "accountInfo": {
        "accountType": "GBP_ACCOUNT",
        "pixKey": "<string>",
        "taxId": "<string>",
        "paymentRails": [
          "PIX"
        ],
        "beneficiary": {
          "beneficiaryType": "INDIVIDUAL",
          "fullName": "<string>",
          "birthDate": "<string>",
          "nationality": "<string>",
          "email": "<string>",
          "phoneNumber": "<string>",
          "countryOfResidence": "<string>",
          "address": {
            "line1": "123 Main Street",
            "postalCode": "94105",
            "country": "US",
            "line2": "Apt 4B",
            "city": "San Francisco",
            "state": "CA"
          }
        }
      },
      "customerId": "Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7",
      "platformAccountId": "acc_123456789",
      "defaultUmaDepositAccount": false,
      "beneficiaryVerifiedData": {
        "fullName": "John Doe"
      },
      "cryptoNetwork": "SOLANA_MAINNET"
    }
  ]
}
{
  "status": 400,
  "message": "<string>",
  "details": {}
}
{
  "status": 401,
  "message": "<string>",
  "details": {}
}
{
  "status": 500,
  "message": "<string>",
  "details": {}
}

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

​
data
object[]
required

List of external accounts matching the filter criteria