Payment Link API Reference

The Payment Link API is deprecated. Use the Checkouts API for all new integrations. If you are currently using the Payment Link API, see the migration guide.

Introduction

The Payment Link API enables developers to create and manage payment links for cryptocurrency payments. These APIs provide a simple way to request payments from users by generating shareable URLs that handle the payment flow, including address generation, transaction monitoring, and status updates. Real-time payment notifications are available through webhooks.

To use these APIs, you need a Coinbase Business account.

Base URL

https://business.coinbase.com/api/v1/payment-links

Authentication

All Payment Link API endpoints require authentication using a JWT Bearer token. See the Authentication guide for details on generating your token.

Available Endpoints

• Create Payment Link - Creates a new payment link
• List Payment Links - Retrieves a paginated list of payment links
• Get Payment Link - Retrieves details of a specific payment link
• Deactivate Payment Link - Deactivates a payment link

Payment Link Status

Payment links can have the following statuses:

• ACTIVE - The payment link is active and can accept payments
• DEACTIVATED - The payment link has been manually deactivated
• EXPIRED - The payment link has expired based on the expiresAt timestamp
• COMPLETED - The payment link has been successfully paid