Node.js Typescript Coinbase Commerce API

Node.js connector for the Coinbase Commerce API with Typescript.

• Simple and unopiniated connector.
• Actively maintained with a modern, promise-driven interface.
• Strongly typed on all requests and responses.
• Lightweight package and snappy DX.
• Proxy support via axios integration.
• Client samples, webhook samples and code snippet examples

Installation

npm install node-coinbase-commerce

Examples

Refer to the examples folder for implementation demos.

Usage

Create an API client

1import { CoinbaseCommerceClient } from "node-coinbase-commerce";
2
3export const client = new CoinbaseCommerceClient(API_KEY);

Charges

1const charges = await client.listCharges();

1const checkout = await client.createCharge({
2	name: "Product name",
3	description: "Product description",
4	pricing_type: "fixed_price",
5	local_price: {
6		amount: 100,
7		currency: "USDT", // BTC, ETH, USDT
8	},
9	metadata: {
10		customer_id: "Customer id",
11		customer_name: "Customer name",
12	},
13	redirect_url: "http://example.com/redirect_url",
14	cancel_url: "http://example.com/cancel_url",
15});

1const charge = await client.showCharge({
2	charge_code_or_charge_id: "XXX",
3});

1const charge = await client.cancelCharge({
2	charge_code_or_charge_id: "XXX",
3});

1const charge = await client.resolveCharge({
2	charge_code_or_charge_id: "XXX",
3});

Checkouts

1const checkouts = await client.listCheckouts();

1const checkout = await client.createCheckout({
2	name: "Product name",
3	description: "Product description",
4	requested_info: ["name", "email", "address", "phone"],
5	pricing_type: "fixed_price",
6	local_price: {
7		amount: 100,
8		currency: "USDT", // BTC, ETH, USDT
9	},
10});

1const checkout = await client.showCheckout({
2	checkout_id: "XXX",
3});

1const checkout = await client.updateCheckout({
2	checkout_id: "XXX",
3	name: "Product name",
4	description: "Product description",
5	requested_info: ["name", "email", "address", "phone"],
6	pricing_type: "fixed_price",
7	local_price: {
8		amount: 100,
9		currency: "USDT", // BTC, ETH, USDT
10	},
11});

1await client.deleteCheckout({
2	checkout_id: "XXX",
3});

Invoices

1const invoices = await client.listInvoices();

1const invoice = await client.createInvoice({
2	business_name: "XXX",
3	customer_email: "xxx@xxx.xxx", // has to be email
4	customer_name: "XXX",
5	memo: "XXX",
6	local_price: {
7		amount: 100,
8		currency: "USDT", // BTC, ETH, USDT
9	};
10})

1const invoice = await client.showInvoice({
2	invoice_code_or_invoice_id: "XXX",
3});

1const invoice = await client.voidInvoice({
2	invoice_code_or_invoice_id: "XXX",
3});

1const invoice = await client.resolveInvoice({
2	invoice_code_or_invoice_id: "XXX",
3});

Events

1const events = await client.listEvents();

1const invoice = await client.showEvent({
2	event_id: "XXX", // uuidv4
3});

Webhooks

Verify a webhook

1const { isVerified, error, typedBody } = verifyWebhook(
2	req.body,
3	req.headers["x-cc-webhook-signature"],
4	WEBHOOK_SHARED_SECRET,
5);