Create a payment link

Creates a shareable payment link that opens the hosted payment page. Omit amount for an open amount (the customer enters it). reusable false (default) = single-use.

Authorization

ApiKey

X-Api-Key<token>

Merchant API key for authentication

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount?integer

Amount to charge, in minor units. Omit for an open amount (the customer enters it).

Range0 < value

currency*string

ISO 4217 three-letter currency code, e.g. EUR.

Length3 <= length <= 3

description?string

Description shown on the payment page.

Lengthlength <= 191

reference?string

Your reference, echoed on the minted payment. Generated when omitted.

Lengthlength <= 191

customer?

Customer you already know. Prefilled on the payment page and shown read-only there; the payer fills in whatever you omit.

capture_mode?string

automatic (default) authorizes and captures; manual authorizes only.

Value in

"automatic"
"manual"

reusable?boolean

false (default) = single-use (closed after the first paid session); true = reusable.

expires_at?string

When the link stops accepting payments (ISO 8601). Defaults to 30 days.

Formatdate-time

return_url?string

URL to return to after payment.

Formaturi

Lengthlength <= 500

webhook_url?string

Per-payment webhook URL (https) forwarded to minted sessions.

Formaturi

Lengthlength <= 500

metadata?

Arbitrary key/value pairs forwarded to the minted payment.

Response Body

`application/json`

curl -X POST "https://example.com/payment-links" \  -H "Content-Type: application/json" \  -d '{    "amount": 4999,    "currency": "EUR",    "description": "Invoice #1234",    "reference": "inv_1234"  }'

{  "id": "string",  "url": "string",  "amount": 0,  "currency": "str",  "description": "string",  "reference": "string",  "customer": {    "first_name": "string",    "last_name": "string",    "email": "string",    "country": "string"  },  "capture_mode": "automatic",  "reusable": true,  "status": "active",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`