---
title: "Payment Link"
method: POST
path: "/api/checkout/v1/payment-link/"
tags: ["api"]
---

# Payment Link

`POST /api/checkout/v1/payment-link/`

An endpoint that generates a new payment link for a given set of products.

## Request body

- CreatePaymentLink
  - `delivery_options` string[]
  - `products` PaymentLinkProduct[], required
    - `name` string, required — The name of the product to be purchased.
    - `description` string, required — The description of the product to be purchased.
    - `minor_amount` integer, required — Amount to be refunded as minor amount integer
    - `currency` string, required — The currency to refund.
    - `allowed_terms` integer[], nullable
    - `sku` string — The SKU of the product to be purchased.
  - `quantity` integer — The number of this product being purchased (fixed if specified)

## Response `200`

- CreatePaymentLinkResponse
  - `payment_link_url` string, required — The URL of the payment link to be given to the customer.

## Other responses

- `500`

---

[API](https://skmtc.net/heylight/apis/heidipay-checkout-api.md) · [All operations](https://skmtc.net/heylight/apis/heidipay-checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/heylight/heidipay-checkout-api/versions/c51570cfc888/schema)