Payments
POST /public/v1/bookings/{reference}/deposit-link (send_deposit_link) needs the payments.send-link capability and, like every booking change, the reference and the phone number on the booking.
Where the link goes
Section titled “Where the link goes”The link is texted only to the phone number stored on the booking. The phone in your request proves the caller knows the booking; it is never where the text goes. There is no way to send the link to another number or by email through the API.
What gets sent
Section titled “What gets sent”- A held booking (waiting for its deposit) is texted its open link again, for the same amount and expiry.
- A confirmed booking that now owes more, for example after a bigger party, gets a new link for the difference (the top-up).
- Payment links last 30 minutes. A held booking whose link expires is released.
The summary says how much and when the link expires, for example “I’ve texted the £90.00 deposit link to the number on the booking. It expires at 20:41.”
When it can’t be sent
Section titled “When it can’t be sent”| Problem | Why |
|---|---|
409 no-deposit-due |
Nothing is owed. |
409 deposit-link-unavailable |
The venue hasn’t set up its SMS deposit-link template, or the booking has no phone number. |
409 booking-not-changeable |
The hold has expired, or the booking isn’t held or confirmed. |
429 too-many-links |
Three texts have already gone to this booking in the last hour. Wait for Retry-After. |