List platform internal accounts

Retrieve a list of all internal accounts that belong to the platform, as opposed to an individual customer.

These accounts are created automatically when the platform is configured for each supported currency. They can be used for things like distributing bitcoin rewards to customers, or for other platform-wide purposes.

GET /platform/internal-accounts

cURL

cURL

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

200

{
  "data": [
    {
      "id": "InternalAccount:12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
      "type": "INTERNAL_FIAT",
      "status": "ACTIVE",
      "balance": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "totalBalance": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "fundingPaymentInstructions": [
        {
          "accountOrWalletInfo": {
            "accountType": "USD_ACCOUNT",
            "accountNumber": "1234567890",
            "routingNumber": "021000021",
            "bankName": "Chase Bank",
            "intermediaryBankName": "JPMorgan Chase Bank",
            "intermediaryRoutingNumber": "021000021",
            "fiToFiInformation": "/BNF/Invoice 4471"
          },
          "instructionsNotes": "Please ensure the reference code is included in the payment memo/description field",
          "isPlatformAccount": true
        }
      ],
      "createdAt": "2025-10-03T12:30:00Z",
      "updatedAt": "2025-10-03T12:30:00Z",
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "label": "invoice-4417",
      "sweepRule": {
        "destination": {
          "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
          "paymentRail": "ACH"
        },
        "minimumAmount": {
          "amount": 12550,
          "currency": {
            "code": "USD",
            "name": "United States Dollar",
            "symbol": "$",
            "decimals": 2
          }
        },
        "maximumAmount": {
          "amount": 12550,
          "currency": {
            "code": "USD",
            "name": "United States Dollar",
            "symbol": "$",
            "decimals": 2
          }
        },
        "purposeOfPayment": "SELF",
        "description": "Rent sweep",
        "remittanceInformation": "Unit 4B March",
        "platformFeeOverride": {
          "platformFixedFee": {
            "amount": 50,
            "currency": "USD"
          },
          "platformVariableFeeBps": 30
        }
      },
      "privateEnabled": true,
      "cardCapabilities": {
        "supportsSpendLimits": true,
        "supportsSpendLimitsAtIssuance": true,
        "supportsTransactionCountLimit": true,
        "supports3dSecurePassword": false,
        "supportsPanReveal": true,
        "supportsDigitalWalletTokenization": true
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Query Parameters

currency · string

Filter by currency code

type · enum<string>

Filter by internal account type. Use EMBEDDED_WALLET to find the self-custodial wallet provisioned for a customer, INTERNAL_FIAT / INTERNAL_CRYPTO for the platform-managed holding accounts, RULE_BASED for the additional account numbers issued with a sweep rule, or BULK_SETTLEMENT for the account that receives bulk settlements. Classification of an internal account.

• INTERNAL_FIAT: A Grid-managed fiat holding account (for example, the USD holding account used as the source for Payouts flows).
• INTERNAL_CRYPTO: A Grid-managed crypto holding account denominated in a stablecoin such as USDC.
• EMBEDDED_WALLET: A self-custodial Embedded Wallet provisioned for the customer. Outbound transfers require a session signature produced by the customer's device — see the Embedded Wallets guide.
• RULE_BASED: An additional account number for an existing account holder, with a routing rule attached, so incoming payments can be attributed to a specific payer and swept automatically. Created with POST /internal-accounts.
• BULK_SETTLEMENT: An account for receiving bulk payments (for example, a single settlement from a payment processor) that the platform then pays out to its customers. Only a platform can hold one, and funds in it can move only to the platform's customers.

Available options: INTERNAL_FIAT, INTERNAL_CRYPTO, EMBEDDED_WALLET, RULE_BASED, BULK_SETTLEMENT

Response

200

application/json

Successful operation

data · object[] · required

List of internal accounts matching the filter criteria

Show child attributes