---
title: "Create a deposit payment link"
method: POST
path: "/api/business/{businessId}/branch/{branchId}/deposit/payment-link"
tags: ["Deposit"]
---

# Create a deposit payment link

`POST /api/business/{businessId}/branch/{branchId}/deposit/payment-link`

Create a payment link for an in-house deposit on the specified appointments. The deposit amount is automatically calculated based on the branch's deposit settings for the given appointments. Returns the payment link URL which can be shared with the client. Optionally notify the client via SMS and/or email. Expiry and auto-cancel settings can be overridden per request; if not provided, the branch's default payment link processing settings are used.

## Path parameters

- `businessId` string, required
- `branchId` string, required

## Request body

- DepositPaymentLinkRequest
  - `appointmentIds` string[], required — List of appointment IDs to create a deposit payment link for
  - `notifyViaSms` boolean — Automatically notify the client via SMS when the payment link is created
  - `notifyViaEmail` boolean — Automatically notify the client via email when the payment link is created
  - `autoCancelAppointmentOnExpiry` boolean — Automatically cancel the appointment when the payment link expires. If not provided, the branch default setting is used.
  - `expiryEnabled` boolean — Whether link expiry is enabled. If not provided, the branch default setting is used.
  - `expiryDeadline` integer — Expiry deadline value (used together with expiryTimeUnit). If not provided, the branch default setting is used.
  - `expiryTimeUnit` string — Expiry time unit (e.g. HOURS, DAYS). If not provided, the branch default setting is used.

## Response `201`

Deposit payment link created successfully

- DepositPaymentLinkResponse
  - `paymentLinkId` string
  - `url` string — The payment link URL that can be shared with the client
  - `status` string
  - `appointmentIds` string[]
  - `notifiedViaSms` boolean — Whether the client was notified via SMS
  - `notifiedViaEmail` boolean — Whether the client was notified via email

## Other responses

- `400` — Bad Request
- `404` — Business, branch, or appointment with the specified ids don't exist
- `429` — Request rate limit exceeded. Current limit set to 100 rps.
- `500` — Internal Server Error

---

[API](https://skmtc.net/phorest/apis/third-party-api.md) · [All operations](https://skmtc.net/phorest/apis/third-party-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/phorest/third-party-api/revisions/2218bc90d39c/schema)