Payment Links & Payments

Use these endpoints to generate fixed-amount payment links on the fly and query incoming payments for reconciliation — for example, per-user or per-reference billing flows.

Create a Payment Link

Generates a shareable payment link (Smart Link) with a fixed amount and a custom description you can use as a reference when reconciling.

string

required

Bearer token with billing.write scope

POST /api/v1/payment-links

Request Body

string

required

Your internal reference, shown on the payment page and included in all webhook payloads and payment records. Example: JMIT-githubuser

number

required

Fixed payment amount in euros (decimal). Example: 49.00

string

default:"EUR"

3-letter ISO currency code. Defaults to EUR.

Request Example

curl -X POST "https://payrequest.app/api/v1/payment-links" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "JMIT-githubuser",
    "amount": 49.00
  }'

Response

{
  "success": true,
  "data": {
    "id": 42,
    "url": "https://payrequest.me/jmit/jmit-githubuser",
    "description": "JMIT-githubuser",
    "amount": 49.00,
    "currency": "EUR",
    "created_at": "2026-05-30T12:00:00+02:00"
  }
}

The URL slug is automatically derived from your description (e.g. JMIT-githubuser → jmit-githubuser). If a link with that slug already exists, a numeric suffix is appended (jmit-githubuser-2).

List Payment Links

Returns a paginated list of all your payment links.

string

required

Bearer token with billing.read scope

integer

default:"25"

Number of results per page (max 100)

GET /api/v1/payment-links

Request Example

curl "https://payrequest.app/api/v1/payment-links?per_page=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

{
  "success": true,
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 42,
        "url": "https://payrequest.me/jmit/jmit-githubuser",
        "description": "JMIT-githubuser",
        "amount": 49.00,
        "currency": "EUR",
        "payments_count": 1,
        "revenue": 49.00,
        "is_active": true,
        "created_at": "2026-05-30T12:00:00+02:00"
      }
    ],
    "per_page": 25,
    "total": 1
  }
}

List Payments

Query incoming payments for reconciliation. Filter by description to find all payments tied to a specific reference.

string

required

Bearer token with billing.read scope

string

Filter payments by description (case-insensitive partial match). Example: JMIT-githubuser

string

Filter by status: paid, open, pending, or failed

date

Start date filter (YYYY-MM-DD)

date

End date filter (YYYY-MM-DD)

integer

default:"25"

Number of results per page (max 100)

GET /api/v1/payments

Request Example

curl "https://payrequest.app/api/v1/payments?description=JMIT-githubuser&status=paid" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

{
  "success": true,
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1234,
        "description": "JMIT-githubuser",
        "amount": 49.00,
        "currency": "EUR",
        "status": "paid",
        "payment_method": "ideal",
        "payment_link_id": 42,
        "payment_link_url": "https://payrequest.me/jmit/jmit-githubuser",
        "reference": "tr_abc123",
        "paid_at": "2026-05-30T11:59:45+02:00",
        "created_at": "2026-05-30T11:58:00+02:00",
        "customer": {
          "id": 99,
          "name": "Jane Doe",
          "email": "jane@example.com"
        }
      }
    ],
    "per_page": 25,
    "total": 1
  }
}

Reconciliation workflow

A typical programmatic billing flow using these endpoints:

Create a payment link with the user’s identifier as description (e.g. JMIT-githubuser)
Send the url to your customer via email or embed it in your app
Receive a webhook (payment.succeeded) with the description and payment_link_id when payment arrives — see Webhooks
Or poll GET /v1/payments?description=JMIT-githubuser&status=paid to reconcile on demand

🚀 Getting Started

🔌 API Reference

🤖 MCP Integration

💳 Payment Processing

📦 Products & Pricing

🧑‍💻 Freelancers & Creators

🔄 Subscriptions

📋 Debt Collection

📄 Invoices

🛍️ Shop & Checkout

👥 Customer Management

🏷️ Organization & Automation

📊 Analytics & Reporting

🏢 Business Settings

🔗 Integrations

🔒 Security & Compliance

🔧 Advanced Features

📝 Updates & Changes

🆘 Troubleshooting

Payment Links & Payments

Payment Links & Payments

Create a Payment Link

Request Body

Request Example

Response

List Payment Links

Request Example

Response

List Payments

Request Example

Response

Reconciliation workflow

​Payment Links & Payments

​Create a Payment Link

​Request Body

​Request Example

​Response

​List Payment Links

​Request Example

​Response

​List Payments

​Request Example

​Response

​Reconciliation workflow

Payment Links & Payments

Create a Payment Link

Request Body

Request Example

Response

List Payment Links

Request Example

Response

List Payments

Request Example

Response

Reconciliation workflow