Skip to main content
Grid provides official SDKs to help you integrate faster. These libraries wrap the Grid API with idiomatic interfaces, type safety, and built-in error handling.

JavaScript / TypeScript

Install via npm and start building with full TypeScript support.
https://mintcdn.com/ramps/REHuvW9ch5b1-5ML/images/icons/kotlin.svg?fit=max&auto=format&n=REHuvW9ch5b1-5ML&q=85&s=4c8730c0f57d4477826876410e581af0

Kotlin

For JVM and Android applications. Available on Maven Central.

​
CLI

The Grid CLI lets you interact with the Grid API directly from your terminal — manage customers, send payments, create quotes, and test in sandbox without writing any code.

Grid CLI

Open-source CLI built with Node.js and TypeScript.

​
Installation

Prerequisites: Node.js v20 or v22 is required. 
git clone https://github.com/lightsparkdev/grid-api.git
cd grid-api/cli
npm install
npm run build
npm link        # makes `grid` available globally

​
Configuration

Configure your credentials interactively: 
grid configure
This prompts for your API Token ID and Client Secret, validates them, and saves to ~/.grid-credentials. Alternatively, set environment variables: 
export GRID_API_TOKEN_ID="your-token-id"
export GRID_API_CLIENT_SECRET="your-client-secret"

​
Commands

CommandDescription
grid configureSet up API credentials
grid config getView platform configuration
grid customers listList customers
grid customers createCreate a customer
grid accounts internal listList internal accounts
grid accounts external createCreate an external bank account or wallet
grid quotes createCreate a payment quote
grid quotes executeExecute a pending quote
grid transfers inTransfer funds in (external to internal)
grid transfers outTransfer funds out (internal to external)
grid transactions listList transactions
grid transactions getGet transaction details
grid receiver lookup-umaLook up a UMA address
grid sandbox fundFund a sandbox account
grid sandbox sendSimulate sending funds to a JIT quote
grid sandbox receiveSimulate receiving a UMA payment
Short aliases are available: cust for customers, tx for transactions, acct for accounts.

​
Example: Send USDC to a Mexico Bank Account

1

Create a customer

grid customers create \
  --platform-id "your-id" \
  --type INDIVIDUAL \
  --full-name "Carlos Garcia" \
  --birth-date "1988-03-20" \
  --address-line1 "Av Reforma 222" \
  --address-city "Mexico City" \
  --address-state "CDMX" \
  --address-postal "06600" \
  --address-country "MX"
2

Create an external CLABE account for the customer

grid accounts external create \
  --customer-id <customerId> \
  --currency MXN \
  --account-type CLABE \
  --clabe "012345678901234567" \
  --beneficiary-type INDIVIDUAL \
  --beneficiary-name "Carlos Garcia" \
  --beneficiary-birth-date "1988-03-20" \
  --beneficiary-nationality MX
3

Create a quote

grid quotes create \
  --source-customer <customerId> \
  --source-currency USDC \
  --dest-account <externalAccountId> \
  --dest-currency MXN \
  --amount 100000 \
  --lock-side RECEIVING
4

In sandbox, simulate the USDC deposit

grid sandbox send --quote-id <quoteId> --currency USDC
5

Check transaction status

grid transactions get <transactionId>
All amounts are in the smallest currency unit (e.g., cents for USD, satoshis for BTC). Quotes expire in 1–5 minutes.