List Customer internal accounts

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

{
  "data": [
    {
      "id": "InternalAccount:12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
      "balance": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "fundingPaymentInstructions": [
        {
          "accountOrWalletInfo": {
            "accountType": "CLABE",
            "clabeNumber": "123456789012345678",
            "reference": "UMA-Q12345-REF"
          },
          "instructionsNotes": "Please ensure the reference code is included in the payment memo/description field"
        }
      ],
      "createdAt": "2025-10-03T12:30:00Z",
      "updatedAt": "2025-10-03T12:30:00Z",
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

GET

customers

internal-accounts

List Customer internal accounts

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

{
  "data": [
    {
      "id": "InternalAccount:12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
      "balance": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "fundingPaymentInstructions": [
        {
          "accountOrWalletInfo": {
            "accountType": "CLABE",
            "clabeNumber": "123456789012345678",
            "reference": "UMA-Q12345-REF"
          },
          "instructionsNotes": "Please ensure the reference code is included in the payment memo/description field"
        }
      ],
      "createdAt": "2025-10-03T12:30:00Z",
      "updatedAt": "2025-10-03T12:30:00Z",
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001"
    }
  ],
  "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

customerId

string

Filter by internal accounts associated with a specific customer

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

Successful operation

data

object[]

required

List of internal accounts matching the filter criteria

Show child attributes

data.id

string

required

The ID of the internal account

Example:

"InternalAccount:12dcbd6-dced-4ec4-b756-3c3a9ea3d123"

data.balance

object

required

Show child attributes

data.balance.amount

integer<int64>

required

Amount in the smallest unit of the currency (e.g., cents for USD/EUR, satoshis for BTC)

Example:

12550

data.balance.currency

object

required

Show child attributes

data.balance.currency.code

string

Three-letter currency code (ISO 4217) for fiat currencies. Some cryptocurrencies may use their own ticker symbols (e.g. "BTC" for Bitcoin, "USDC" for USDC, etc.)

Example:

"USD"

data.balance.currency.name

string

Full name of the currency

Example:

"United States Dollar"

data.balance.currency.symbol

string

Symbol of the currency

Example:

"$"

data.balance.currency.decimals

integer

Number of decimal places for the currency

Required range: x >= 0

Example:

2

data.fundingPaymentInstructions

object[]

required

Payment instructions for funding the account

Show child attributes

data.fundingPaymentInstructions.accountOrWalletInfo

CLABE Account · object

required

CLABE Account
US Bank Account
PIX Account
IBAN Account
FBO Account
UPI Account
Spark Wallet
Lightning Invoice
Solana Wallet
Tron Wallet
Polygon Wallet
Base Wallet

Show child attributes

data.fundingPaymentInstructions.accountOrWalletInfo.accountType

enum<string>

required

Type of account or wallet information

Available options:

CLABE

Example:

"CLABE"

data.fundingPaymentInstructions.accountOrWalletInfo.clabeNumber

string

required

18-digit CLABE number (Mexican banking standard)

Required string length: 18

Example:

"123456789012345678"

data.fundingPaymentInstructions.accountOrWalletInfo.reference

string

required

Unique reference code that must be included with the payment to properly credit it

Example:

"UMA-Q12345-REF"

data.fundingPaymentInstructions.instructionsNotes

string

Additional human-readable instructions for making the payment

Example:

"Please ensure the reference code is included in the payment memo/description field"

data.createdAt

string<date-time>

required

Timestamp when the internal account was created

Example:

"2025-10-03T12:30:00Z"

data.updatedAt

string<date-time>

required

Timestamp when the internal account was last updated

Example:

"2025-10-03T12:30:00Z"

data.customerId

string

The ID of the customer associated with the internal account. If this field is empty, the internal account belongs to the platform.

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"

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 customers matching the criteria (excluding pagination)

Get bulk import job status List platform internal accounts

⌘I

Using the API

API documentation

List Customer internal accounts

Authorizations

Query Parameters

Response