v33

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-28103497709.6 KB
Internal Accounts

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

Query parameters

currencystring

Filter by currency code

type'INTERNAL_FIAT' | 'INTERNAL_CRYPTO' | 'EMBEDDED_WALLET'

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.

Filter by internal account type. Use EMBEDDED_WALLET to find the self-custodial wallet provisioned for a customer, or INTERNAL_FIAT / INTERNAL_CRYPTO for the platform-managed holding accounts.

Response

Successful operation

Example response

{
  "data": [
    {
      "id": "InternalAccount:12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "status": "ACTIVE",
      "balance": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "fundingPaymentInstructions": [
        {
          "instructionsNotes": "Please ensure the reference code is included in the payment memo/description field",
          "isPlatformAccount": true,
          "accountOrWalletInfo": {
            "accountType": "USD_ACCOUNT",
            "accountNumber": "1234567890",
            "routingNumber": "021000021"
          }
        }
      ],
      "privateEnabled": true,
      "createdAt": "2025-10-03T12:30:00Z",
      "updatedAt": "2025-10-03T12:30:00Z"
    }
  ]
}