send_deposit_link
Text a deposit link. Text the guest the link to pay their deposit, or a top-up after a bigger party. It only ever goes to the phone number stored on the booking; the phone you give just confirms who is asking. Use it when the guest says they didn’t get the link or after amend_booking reports a top-up. The summary says the amount and when the link expires.
It changes data. Calling it again with the same input has no further effect.
Parameters
Section titled “Parameters”| Name | Type | Required | Description |
|---|---|---|---|
reference |
string | Yes | The booking reference, eight digits; spaces are fine. |
phone |
string | Yes | The phone number on the booking. |
venueId |
string (uuid) | No | The venue’s id, when the key covers several venues. |
idempotencyKey |
string | No | Optional: your own key for this request, to make retries safe beyond 10 minutes. |
REST equivalent
Section titled “REST equivalent”SendDepositLink: POST /public/v1/bookings/{reference}/deposit-link, which needs the payments.send-link capability.