API referencePayment Link
Send Payment Link
Create a Stripe payment link for a booking and store it as a payment. Returns the payment row including paymentData.payment_link_url. App connections need the booking:write scope.
POST
/payment-linkcurl -X POST "https://dash.lockii.app/api/v1/payment-link" \
-H "x-api-key: $LOCKII_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"orderID": "string",
"amount": 0
}'Authorization
x-api-keystringheaderAPI key from Settings → Integrations → API.
AuthorizationstringheaderThe same API key, or an OAuth access token, sent as Authorization: Bearer.
api_keystringqueryAPI key query parameter.
Body
application/json
idstringPayment ID. Defaults to a generated payment_<uuid>.
orderIDstringrequiredBooking/order ID to request payment for
amountnumberrequiredAmount to request in cents
companyIDstringCompany ID. Defaults to the authenticated user's company.
Response
application/json
JSON result for this operation.
object
{}