Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Pay By Link

Create a Pay By Link

post/pay-by-link

Headers

X-Property-Idstring required

The property ID of the client

Request body

paidnumber double required

The amount to charge via the payment link. Must be greater than 0

descriptionstring nullable

Description of the created payment posted to folio. Explains what the payment is for

propertyIdstring

The property ID associated with the inventory object. Must be a valid Cloudbeds property ID

folio_idinteger nullable

The folio ID to associate the payment created with this pay by link to. If not provided, the payment will be associated to the default folio

expires_afterinteger

Number of days the payment link remains valid. Maximum 30 days

auth_paymentboolean

Payment capture method. Set to false for immediate payment collection, true for card authorization only (capture later via PMS UI)

Example request

{
  "folio_id": 123456,
  "paid": 150.5,
  "expires_after": 7,
  "description": "Balance for your stay at Hotel California",
  "auth_payment": false,
  "inventoryObject": {
    "type": "reservation",
    "id": "789012"
  },
  "propertyId": "210643"
}

Response

Successfully created pay by link

urlstring uri required

The payment link URL to send to the customer. This URL directs them to the secure payment page

idstring uuid required

Unique identifier (UUID) for the created payment link. Use this to track and manage the payment link

expires_atstring date-time required

Expiration date and time for the payment link. After this time, the link will no longer accept payments

Example response

{
  "url": "https://pay-by-link.cloudbeds.com/#/payment/123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "expires_at": "2024-12-31T23:59:59"
}