Coinbase Payments

✅ Unofficial Coinbase Commerce JS API | Receive BTC, ETH, LTC, DOGE and others | The simplest way to receive crypto payments on your website!

NPM Package

Install

Add "coinbase-payments" to your project:

1  npm install coinbase-payments

or

1  yarn add coinbase-payments

Usage

• Create account on https://commerce.coinbase.com and get API Key on "Account Settings".

• Creating new charge:

1const Coinbase = require('coinbase-payments');
2const coinbase = Coinbase('COINBASE_COMMERCE_KEY');
3...
4    const charge = await coinbase.createCharge({
5        title: 'New order',
6        description: 'Example order',
7        amount: 5,
8        currency: 'USD',
9        metadata: { order_id: 'random123', customer_id: 'random123' },
10    });
11    console.log(charge);

• Get charge status:

1const Coinbase = require('coinbase-payments');
2const coinbase = Coinbase('COINBASE_COMMERCE_KEY');
3...
4    const status = await coinbase.getChargeStatus(id);
5    console.log(status);
6      // "NEW" = Waiting payment
7      // "PENDING" = Payment received, confirming...
8      // "COMPLETE" = Completed / Confirmed
9      // "FAILED" = Expired/Failed payment

• Get charge details:

1const Coinbase = require('coinbase-payments');
2const coinbase = Coinbase('COINBASE_COMMERCE_KEY');
3...
4    const charge = await coinbase.getCharge(id);
5    console.log(charge);
6

Charge Example (Object)

1  {
2    id: '8192b4a8-cd34-4f9e-a075-53ca2a0f5c53',
3    addresses: {
4      ethereum: '0xc8d96a6f966245cb250b18ddbdf1b8638827a123',
5      dogecoin: 'DDHAcyJoSABXCVyWLBuBqso2TKGc7ufGhf',
6      litecoin: 'MWRK7pK3Z9JBaNrBNUuNzmutbHHFwF7TPv',
7      bitcoin: '3NNvwQMtLGG9Yc5n2JnzSaVbFgr1awF9Es',
8      // more...
9    },
10    brand_color: '#122332',
11    brand_logo_url: '',
12    code: 'V93JF0CF',
13    coinbase_managed_merchant: false,
14    created_at: '2023-05-17T19:26:18Z',
15    description: 'Example order',
16    exchange_rates: {
17      'ETH-USD': '1830.54',
18      'BTC-USD': '27344.205',
19      'LTC-USD': '94.84',
20      'DOGE-USD': '0.0752',
21      'BCH-USD': '118.4',
22      // more...
23    },
24    expires_at: '2023-05-17T20:26:18Z',
25    fee_rate: 0.01,
26    fees_settled: true,
27    hosted_url: 'https://commerce.coinbase.com/charges/V93JF0CF',
28    local_exchange_rates: {
29      'ETH-USD': '1830.54',
30      'BTC-USD': '27344.205',
31      'LTC-USD': '94.84',
32      'DOGE-USD': '0.0752',
33      // more...
34    },
35    logo_url: '',
36    metadata: {},
37    name: 'New order',
38    offchain_eligible: false,
39    organization_name: '',
40    payment_threshold: {
41      overpayment_absolute_threshold: { amount: '5.00', currency: 'USD' },
42      overpayment_relative_threshold: '0.005',
43      underpayment_absolute_threshold: { amount: '5.00', currency: 'USD' },
44      underpayment_relative_threshold: '0.005'
45    },
46    payments: [],
47    pricing: {
48      local: { amount: '5.00', currency: 'USD' },
49      polygon: { amount: '5.644934000', currency: 'PMATIC' },
50      pusdc: { amount: '5.000000', currency: 'PUSDC' },
51      pweth: { amount: '0.002731434440110568', currency: 'PWETH' },
52      // more...
53    },
54    pricing_type: 'fixed_price',
55    pwcb_only: false,
56    resource: 'charge',
57    support_email: 'yourmail@hotmail.com',
58    timeline: [ { status: 'NEW', time: '2023-05-17T19:26:19Z' } ],
59    utxo: false
60  }

Reference

• Coinbase Commerce API

Buy me a coffee ☕

If you liked it and want this project to stay active, buy me a coffee.

  - BTC: 1KmZyRhAVcAMH8vJKcGPNp5QpCJ3HNZgzv
  - ETH: 0x42eF534C4172b02351b90A4184bedCD8bcfE8eE6
  - LTC: LbendKmgoYy8hgMMZMWtxNNNjeJh5CYo7Q