Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ sequenceDiagram
else Asynchronous Processing (within 5 seconds)
Client-->>Grid: HTTP 202 Accepted
Client->>Grid: /transactions/{transactionId}/approve or /reject
opt Approved
alt Approved
Grid->>Bank: Execute payment to user's bank account
Grid->>Client: Webhook: INCOMING_PAYMENT (COMPLETED)
Client-->>Grid: HTTP 200 OK (acknowledge completion)
Expand Down
15 changes: 15 additions & 0 deletions mintlify/api-reference/sdks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'SDKs & CLI'
icon: "/images/icons/code.svg"
description: 'Official client libraries and command-line interface for the Grid API'
"og:image": "/images/og/og-api-reference-generic.png"
---

import Sdks from '/snippets/sdks.mdx';
import Cli from '/snippets/cli.mdx';

<Sdks />

## CLI

<Cli />
3 changes: 2 additions & 1 deletion mintlify/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,8 @@
"api-reference/terminology",
"api-reference/authentication",
"api-reference/webhooks",
"api-reference/sandbox-testing"
"api-reference/sandbox-testing",
"api-reference/sdks"
]
},
{
Expand Down
3 changes: 3 additions & 0 deletions mintlify/images/icons/kotlin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
118 changes: 118 additions & 0 deletions mintlify/snippets/cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
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.

<Card
title="Grid CLI"
icon="square-terminal"
href="https://github.com/lightsparkdev/grid-api/tree/main/cli"
>
Open-source CLI built with Node.js and TypeScript.
</Card>

### Installation

**Prerequisites:** Node.js v20 or v22 is required.

```bash
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:

```bash
grid configure
```

This prompts for your API Token ID and Client Secret, validates them, and saves to `~/.grid-credentials`.

Alternatively, set environment variables:

```bash
export GRID_API_TOKEN_ID="your-token-id"
export GRID_API_CLIENT_SECRET="your-client-secret"
```

### Commands

| Command | Description |
|---------|-------------|
| `grid configure` | Set up API credentials |
| `grid config get` | View platform configuration |
| `grid customers list` | List customers |
| `grid customers create` | Create a customer |
| `grid accounts internal list` | List internal accounts |
| `grid accounts external create` | Create an external bank account or wallet |
| `grid quotes create` | Create a payment quote |
| `grid quotes execute` | Execute a pending quote |
| `grid transfers in` | Transfer funds in (external to internal) |
| `grid transfers out` | Transfer funds out (internal to external) |
| `grid transactions list` | List transactions |
| `grid transactions get` | Get transaction details |
| `grid receiver lookup-uma` | Look up a UMA address |
| `grid sandbox fund` | Fund a sandbox account |
| `grid sandbox send` | Simulate sending funds to a JIT quote |
| `grid sandbox receive` | Simulate 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

<Steps>
<Step title="Create a customer">
```bash
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"
```
</Step>
<Step title="Create an external CLABE account for the customer">
```bash
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
```
</Step>
<Step title="Create a quote">
```bash
grid quotes create \
--source-customer <customerId> \
--source-currency USDC \
--dest-account <externalAccountId> \
--dest-currency MXN \
--amount 100000 \
--lock-side RECEIVING
```
</Step>
<Step title="In sandbox, simulate the USDC deposit">
```bash
grid sandbox send --quote-id <quoteId> --currency USDC
```
</Step>
<Step title="Check transaction status">
```bash
grid transactions get <transactionId>
```
</Step>
</Steps>

Comment thread
greptile-apps[bot] marked this conversation as resolved.
<Note>
All amounts are in the **smallest currency unit** (e.g., cents for USD, satoshis for BTC). Quotes expire in 1–5 minutes.
</Note>
Comment thread
greptile-apps[bot] marked this conversation as resolved.
18 changes: 18 additions & 0 deletions mintlify/snippets/sdks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
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.

<CardGroup cols={2}>
<Card
title="JavaScript / TypeScript"
icon="js"
href="https://github.com/lightsparkdev/grid-js-sdk"
>
Install via npm and start building with full TypeScript support.
</Card>
<Card
title="Kotlin"
icon="/images/icons/kotlin.svg"
href="https://github.com/lightsparkdev/grid-kotlin-sdk"
>
For JVM and Android applications. Available on Maven Central.
</Card>
</CardGroup>
Loading