Skip to main content
GET
/
api
/
v1
/
payment-links
List Payment Links
curl --request GET \
  --url https://business.coinbase.com/api/v1/payment-links \
  --header 'Authorization: Bearer <token>'
{
  "paymentLinks": [
    {
      "id": "68f7a946db0529ea9b6d3a12",
      "url": "https://pay.coinbase.com/pl_01h8441j23abcd1234567890ef",
      "status": "ACTIVE",
      "amount": "100.50",
      "currency": "USDC",
      "network": "base",
      "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "tokenAddress": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
      "description": "Payment for order #12345",
      "expiresAt": "2024-03-20T10:30:00Z",
      "metadata": {
        "invoiceId": "12345",
        "reference": "Payment for invoice #12345",
        "customerId": "cust_abc123"
      },
      "successRedirectUrl": "https://example.com/success",
      "failRedirectUrl": "https://example.com/failed",
      "createdAt": "2024-03-20T10:30:00Z",
      "updatedAt": "2024-03-20T10:30:00Z",
      "settlement": {
        "totalAmount": "100.00",
        "feeAmount": "1.25",
        "netAmount": "98.75"
      }
    }
  ],
  "nextPageToken": "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

Authorizations

Authorization
string
header
required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Query Parameters

pageSize
integer
default:20

The number of items to return per page.

Required range: 1 <= x <= 100
pageToken
string

The token for the next page of items. This should only be populated using the nextPageToken value from the previous response.

status
enum<string>

Filter by payment link status.

Available options:
ACTIVE,
DEACTIVATED,
EXPIRED,
COMPLETED
Example:

"ACTIVE"

Response

Payment links retrieved successfully.

nextPageToken
string

The token for the next page of items, if any.

Example:

"eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="