Payment Links API Integration

The Payment Links API allows you to programmatically create and manage payment links. This is ideal for merchants who want to generate links on demand from their own systems, rather than creating them manually through the dashboard.

Payment links are reusable. A payment link can be opened and paid through as many times as you want — static or dynamic. Each time a customer uses a payment link, Basqet creates a new checkout session (transaction) for that use, but the link itself stays active and can be shared again. If you need a one-time payment that expires after a single use, use the Transactions API to initialize a transaction directly instead.

A payment link is a Basqet-hosted checkout page that your customers can open to complete a payment. Links can be:

• Static — a fixed amount is set when the link is created.
• Dynamic — the customer enters the amount at checkout.

Create Payment Link

API Details

Action: Create Payment Link
Method: POST
Path: /v1/payment-links
Auth Requirement: Secret Key

Business Summary

This endpoint creates a new payment link that can be shared with customers. Once created, the link generates a unique, Basqet-hosted checkout URL your customers can use to complete a crypto payment.

You can use this API to:

• Programmatically generate payment links for invoices, orders, or recurring billing.
• Create fixed-price (static) links for specific products or dynamic links where the customer sets the amount.
• Attach custom metadata to links for your internal tracking.

Request Parameters

Request Headers

Body Parameters

Request Examples

cURL — Static Link

curl --request POST \

  --url https://api.basqet.com/v1/payment-links \

  --header 'Authorization: Bearer sec_live_xxxxxxxxxxxxx' \

  --header 'Content-Type: application/json' \

  --data '{
  "title": "Invoice #1024",

  "link_type": "static",

  "currency": "USD",

  "amount": "150.00",

  "description": "Payment for design services",

  "metadata": {

    "order_id": "order_1024",

    "customer_tier": "premium"

  }
}'

cURL — Dynamic Link

curl --request POST \

  --url https://api.basqet.com/v1/payment-links \

  --header 'Authorization: Bearer sec_live_xxxxxxxxxxxxx' \

  --header 'Content-Type: application/json' \

  --data '{
  "title": "Open Donation",

  "link_type": "dynamic",

  "currency": "USD"
}'

Response Schema

Sample Response

{
  "message": "Payment Link created",
  "id": "bq_pl_aBcDeFgHiJkLmNo",
  "title": "Invoice #1024",
  "link_type": "static",
  "currency": "USD",
  "amount": 150.0,
  "payment_url": "https://pay.basqet.com/pl_aBcDeFgHiJkLmNo",
  "metadata": {
    "order_id": "order_1024",
    "customer_tier": "premium"
  },
  "created_at": "2026-04-22T10:30:00.000Z",
  "last_used": null,
  "deleted_at": null
}

Error Reference

List Payment Links

API Details

Action: List Payment Links
Method: GET
Path: /v1/payment-links
Auth Requirement: Secret Key

Business Summary

Returns a paginated list of payment links for your merchant account. By default, only active (non-deleted) links are returned. Use the status parameter to retrieve archived links.

Request Parameters

Request Headers

Query Parameters

Request Example

cURL

curl --request GET \

  --url 'https://api.basqet.com/v1/payment-links?limit=20&order=desc&status=active' \

  --header 'Authorization: Bearer sec_live_xxxxxxxxxxxxx'

Response Schema

Sample Response

{
  "data": [
    {
      "id": "bq_pl_aBcDeFgHiJkLmNo",
      "title": "Invoice #1024",
      "link_type": "static",
      "currency": "USD",
      "amount": 150.0,
      "payment_url": "https://pay.basqet.com/pl_aBcDeFgHiJkLmNo",
      "metadata": null,
      "created_at": "2026-04-22T10:30:00.000Z",
      "last_used": null,
      "deleted_at": null
    }
  ],
  "meta": {
    "limit": 20,
    "count": 1,
    "hasNext": false
  }
}

...

Get Payment Link

API Details

Action: Get Payment Link
Method: GET
Path: /v1/payment-links/:id
Auth Requirement: Secret Key

Business Summary

Retrieves the details of a single payment link by its ID.

Request Parameters

Request Headers

Path Parameters

Request Example

cURL

\--url <https://api.basqet.com/v1/payment-links/bq_pl_aBcDeFgHiJkLmNo> \\



  \--header 'Authorization: Bearer sec_live_xxxxxxxxxxxxx'```
 
```


<br />

Sample Response

```json
{
  "id": "bq_pl_aBcDeFgHiJkLmNo",
  "title": "Invoice #1024",
  "link_type": "static",
  "currency": "USD",
  "amount": 150.0,
  "payment_url": "https://pay.basqet.com/pl_aBcDeFgHiJkLmNo",
  "metadata": null,
  "created_at": "2026-04-22T10:30:00.000Z",
  "last_used": null,
  "deleted_at": null
}

Error Reference

Update Payment Link

API Details

Action: Update Payment Link
Method: PATCH
Path: /v1/payment-links/:id
Auth Requirement: Secret Key

Business Summary

Updates one or more fields on an existing payment link. At least one field must be provided.

Request Parameters

Request Headers

Path Parameters

Body Parameters

All fields are optional, but at least one must be provided.

Request Example

cURL

curl --request PATCH \

  --url https://api.basqet.com/v1/payment-links/bq_pl_aBcDeFgHiJkLmNo \

  --header 'Authorization: Bearer sec_live_xxxxxxxxxxxxx' \

  --header 'Content-Type: application/json' \

  --data '{
  "title": "Invoice #1024 (Updated)",

  "amount": "200.00"
}'

Sample Response

{
  "id": "bq_pl_aBcDeFgHiJkLmNo",
  "title": "Invoice #1024 (Updated)",
  "link_type": "static",
  "currency": "USD",
  "amount": 200.0,
  "payment_url": "https://pay.basqet.com/pl_aBcDeFgHiJkLmNo",
  "metadata": null,
  "created_at": "2026-04-22T10:30:00.000Z",
  "last_used": null,
  "deleted_at": null
}

Error Reference

Delete Payment Link

API Details

Action: Delete Payment Link
Method: DELETE
Path: /v1/payment-links/:id
Auth Requirement: Secret Key

Business Summary

Soft-deletes a payment link. Deleted links are no longer accessible to customers and are excluded from your default list view. This action cannot be undone via the API.

Request Parameters

Request Headers

Path Parameters

Request Example

cURL

curl --request DELETE \

  --url https://api.basqet.com/v1/payment-links/bq_pl_aBcDeFgHiJkLmNo \

  --header 'Authorization: Bearer sec_live_xxxxxxxxxxxxx'

Sample Response

{
  "id": "bq_pl_aBcDeFgHiJkLmNo",
  "status": "deleted",
  "deleted_at": "2026-04-22T14:00:00.000Z"
}

Error Reference

Notes

• All Merchant API endpoints require a secret key (sec_...) in the Authorization header. Public keys are not accepted.
• Payment links in live mode require your merchant account to have completed KYB verification.
• Deleting a payment link is a soft delete — the record is retained but the link becomes inactive. Use status=archived in the List endpoint to retrieve deleted links.
• The payment_url returned in responses is the shareable link to send to your customers. When a customer opens this URL, they will be taken through the Basqet-hosted checkout flow.
• For merchants using payment links with the Initialize Transaction API, you can pass the payment link's url_slug (prefixed with pl_) as the payment_link parameter when initializing a transaction. This associates the transaction with the link's configuration.
  Message Tega:ai-champion-badge:Prompt Engineer 👷