SDK Reference

1
const { result } = await gwop.invoices.create({
2
  idempotencyKey: crypto.randomUUID(),
3
  body: {
4
    amountUsdc: 5_000_000,       // Required — atomic units (6 decimals)
5
    description: "Starter plan",  // Optional
6
    metadata: { orderId: "123" }, // Optional — arbitrary key-value pairs
7
    metadataPublic: false,        // Optional — expose metadata in public invoice view
8
    expiresInSeconds: 900,        // Optional — TTL (default 900 = 15 min)
9
  },
10
});

1
const { result } = await gwop.invoices.list({
2
  limit: 20,       // Optional — default 20
3
  offset: 0,       // Optional — default 0
4
  status: "PAID",  // Optional — "OPEN", "PAYING", "PAID", "EXPIRED", "CANCELED"
5
});
6
7
result.invoices;          // Array<InvoiceListItem>
8
result.pagination.total;  // Total matching invoices
9
result.pagination.hasMore;

1
const { result } = await gwop.invoices.get({
2
  id: "inv_7dbeeaad8ebf4f5298c380c90e4b3576",
3
});

1
const { result } = await gwop.invoices.cancel({
2
  id: "ba7bc94a-5468-42f4-9f04-2502e50c7501",
3
});
4
5
result.status;     // "CANCELED"
6
result.canceledAt; // ISO 8601

1
const { result } = await gwop.authIntents.create({
2
  idempotencyKey: crypto.randomUUID(),
3
  body: {
4
    knownWalletHint: "0x742d...", // Optional — pre-fill wallet
5
    metadata: { source: "api" },  // Optional
6
  },
7
});
8
9
result.authIntentId;                  // UUID
10
result.challenge.amountUsdcAtomic;    // "1000" ($0.001)
11
result.challenge.paymentMethods;      // Array of payment options

1
const { result } = await gwop.authIntents.exchange({
2
  authIntentId: intent.authIntentId,
3
  idempotencyKey: crypto.randomUUID(),
4
});
5
6
result.accessToken;          // RS256-signed JWT
7
result.principal.sub;        // "base:0x742d..." or "solana:7sSi..."
8
result.account.isNewAccount; // true on first auth

1
const { result } = await gwop.authSessions.get({
2
  sessionId: "sess_...",
3
});
4
5
result.status;        // "active", "revoked", or "expired"
6
result.walletAddress;
7
result.chain;
8
result.expiresAt;

1
await gwop.authSessions.revoke({
2
  sessionId: "sess_...",
3
});

1
const { result } = await gwop.auth.getJwks();
2
// result.keys — Array of JWK objects (RS256)

1
import * as jose from "jose";
2
3
const jwks = jose.createRemoteJWKS(
4
  new URL("https://identity.gwop.io/.well-known/jwks.json"),
5
);
6
7
const { payload } = await jose.jwtVerify(token, jwks, {
8
  issuer: "https://identity.gwop.io",
9
  algorithms: ["RS256"],
10
});

1
const gwop = new Gwop({
2
  merchantApiKey: process.env.GWOP_MERCHANT_API_KEY,
3
  webhookSecret: process.env.GWOP_WEBHOOK_SECRET,
4
});
5
6
const event = await gwop.validateWebhook({
7
  request: {
8
    body: rawBody,
9
    headers: {
10
      "x-gwop-signature": signatureHeader,
11
      "x-gwop-event-id": eventId,
12
      "x-gwop-event-type": eventType,
13
      "content-type": "application/json",
14
    },
15
    url: "https://your-app.com/webhooks/gwop",
16
    method: "POST",
17
  },
18
});
19
20
event.body.eventType;  // "invoice.paid" | "invoice.expired" | "invoice.canceled"
21
event.body.eventId;    // UUID for deduplication
22
event.body.data;       // Typed event data