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

GET /platform/external-accounts

List platform external accounts

cURL

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

200

{
  "data": [
    {
      "id": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
      "status": "ACTIVE",
      "currency": "USD",
      "accountInfo": {
        "accountType": "AED_ACCOUNT",
        "iban": "AE070331234567890123456",
        "swiftCode": "EBILAEAD"
      },
      "customerId": "Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7",
      "platformAccountId": "acc_123456789",
      "ownershipType": "FIRST_PARTY",
      "defaultUmaDepositAccount": false,
      "beneficiaryVerificationStatus": "MATCHED",
      "beneficiaryVerifiedData": {
        "fullName": "John Doe"
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

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

Query Parameters

currency · string

Filter by currency code

limit · integer · default: 20

Maximum number of results to return (default 20, max 100)

Required range: 1 <= x <= 100

cursor · string

Cursor for pagination (returned from previous request)

Response

200

application/json

Successful operation

data · object[] · required

List of external accounts matching the filter criteria

Show child attributes

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)