Create Payment Link

post

https://sandbox.leantech.me/payment-links/v1

Creates a payment link that can be shared with customers to collect payments. The link remains ACTIVE until it expires, reaches its usage limit, or is explicitly disabled.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string | null

A label for your own reference. Not shown to payers. Useful for distinguishing links in list views.

max_usages

int32 | null

≥ 1

The maximum number of successful payments this link will accept. Once reached, the link transitions to USED status and will reject further payment attempts. Omit to allow unlimited uses.

expires_at

date-time | null

The date and time at which this link will automatically expire, in ISO 8601 format. After this time the link transitions to EXPIRED status. Omit to create a link with no expiry.

redirect_url

string

required

The URL your customer is redirected to after completing or cancelling a payment. Must be an absolute URL. You can use query parameters to carry context (e.g., an order ID) back to your application.

customer_id

uuid | null

Associates this link with a specific customer in your system. If provided, all payments will be associated with that customer.

payment_details

object

required

The payment parameters that apply to every transaction made through this link. Fixed at creation time and cannot be changed afterwards.

identifiers

array of objects | null

Additional fields to collect from each payer before they can complete the payment.

identifiers

Response

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Payment link created successfully