LIlightsparkdev
External Accounts

List Customer external accounts

Changed on

Retrieve a list of external accounts with optional filtering parameters. Returns all external accounts that match the specified filters. If no filters are provided, returns all external accounts (paginated).

External accounts are bank accounts, cryptocurrency wallets, or other payment destinations that customers can use to receive funds from the platform.

get/customers/external-accounts

Request

  • Base URL
    https://api.lightspark.com/grid/2025-10-13
  • URL
    https://api.lightspark.com/grid/2025-10-13/customers/external-accounts
  • Auth
    HTTP basic

Query parameters

currencystring

Filter by currency code

customerIdstring

Filter by external accounts associated with a specific customer

limitinteger

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

cursorstring

Cursor for pagination (returned from previous request)

Response

Successful operation

hasMoreboolean required

Indicates if more results are available beyond this page

nextCursorstring

Cursor to retrieve the next page of results (only present if hasMore is true)

totalCountinteger

Total number of external accounts matching the criteria (excluding pagination)

Example response

{
  "data": [
    {
      "id": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
      "customerId": "Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7",
      "platformAccountId": "acc_123456789",
      "ownershipType": "FIRST_PARTY",
      "currency": "USD",
      "beneficiaryVerifiedData": {
        "fullName": "John Doe"
      },
      "accountInfo": {
        "accountType": "AED_ACCOUNT",
        "iban": "AE070331234567890123456",
        "swiftCode": "EBILAEAD"
      }
    }
  ]
}

Changes

  • d996ddfb9d2bRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 715332dcb111Revision changes
    • warning

      added the new EXACT_AMOUNT_UNAVAILABLE enum value to the response property for the response status