Create payment link

Create a payment link to send to a recipient email or phone (via SMS) to take payment.

To see delivery status of the payment link, please see the activity log on the relevant booking in VM.

  • Payment links can be generated for bookings created via both API, and via ROLLER applications.
  • Payment links cannot be created for API-draft, or venue-draft bookings.

Note: If both email and phone is provided, email will be ignored and an SMS will be sent.
Note: Sending payment links to a recipient phone (via SMS) is unsupported in Playground.

This will not create a guest record of the recipient, or attach them to the booking in VM.

šŸ”’

Required scope: PaymentLink_Post

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
Body Params
Responses

400

Bad Request - Validation issue (eg: Email or phone is required).

404

Not Found - No booking found for uniqueIdentifier

409

Conflict - Business rule (eg: Booking already paid, or payment link requests more than current owing amount).

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json