Create a deposit payment link

post

http://api-gateway-eu.phorest.com/third-party-api-server/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. Set cardCaptureOnly to true to create a link that charges nothing and only saves the client's card details. 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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

businessId

string

required

branchId

string

required

Body Params

appointmentIds

array of strings

required

List of appointment IDs to create a deposit payment link for

appointmentIds*

notifyViaSms

boolean

Defaults to false

Automatically notify the client via SMS when the payment link is created

notifyViaEmail

boolean

Defaults to false

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

int32

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.

cardCaptureOnly

boolean

Defaults to false

Create a link that charges nothing and only saves the client's card details. Use this to secure a card for appointments that don't require a deposit. When false or not provided, the link charges the deposit calculated from the branch's deposit settings.

Responses

201Deposit payment link created successfully

400Bad Request

404Business, branch, or appointment with the specified ids don't exist

429Request rate limit exceeded. Current limit set to 100 rps.

500Internal Server Error