Paylinks

A paylink is a payment page you share by URL. The customer opens it and pays by card; no integration on your side is needed. Create and manage paylinks from the dashboard or with a secret key.

Each paylink has a slug, which makes the public URL https://cari.finance/p/{slug}.

Routes (secret key)

POST /paylinks, GET /paylinks, GET /paylinks/{id}, PUT /paylinks/{id}, DELETE /paylinks/{id}

Name
title
Type
string
Description
Required. Shown to the customer.
Name
amount_type
Type
string
Description
Required. fixed or variable (the customer enters the amount).
Name
amount
Type
integer
Description
Smallest currency unit. Required for fixed.
Name
currency
Type
string
Description
Name
description
Type
string
Description
Name
slug
Type
string
Description
A custom slug.
Name
password
Type
string
Description
If set, the customer must enter it before paying.
Name
expires_at
Type
string
Description
ISO 8601.
Name
max_uses
Type
integer
Description

Only card payments are supported. A paylink that is inactive, expired or used up reports available: false and cannot be paid.

Public routes (no key)

These serve the payment page. You do not call them yourself.

GET /p/{slug}: the title, amount, currency and whether a password is needed.
POST /p/{slug}/validate: checks the password.
POST /p/{slug}/pay: takes the payment.

A paylink is paid on its own page. It is not a payment session; there is no session for a paylink.