v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Pay By Link

Retrieve a Pay By Link

get/pay-by-link/{uuid}

Path parameters

uuidstring required

The pay by link UUID.

Headers

X-Property-Idstring required

The property ID of the client making the request. This header is required and enforced by the authentication layer.

Response

The pay by link associated to the UUID

idstring uuid required

Unique identifier (UUID) of the payment link

propertyIdinteger required

The Cloudbeds property ID this payment link is associated with

folioIdinteger nullable

The folio ID this payment link is associated with. May be null, 0, or indicate the default folio

Current status of the payment link

completedAtstring date-time nullable

Timestamp when the payment was completed. Null if payment is not yet complete

expiresAtstring date-time required

Timestamp when the payment link will expire and no longer accept payments

createdAtstring date-time required

Timestamp when the payment link was created

notesstring nullable

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

expiredboolean required

Indicates whether the payment link has expired

paidboolean required

Indicates whether the payment has been completed

readyForPaymentboolean required

Indicates whether the payment link is active and ready to accept payments

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "propertyId": 210643,
  "folioId": 123456,
  "payByLinkStatus": "SENT",
  "completedAt": null,
  "expiresAt": "2024-12-31T23:59:59",
  "createdAt": "2024-11-01T10:00:00",
  "captureMethod": "charge",
  "cost": {
    "amount": 150.5,
    "currency": "USD"
  },
  "notes": "Balance for stay",
  "expired": false,
  "paid": false,
  "readyForPayment": true
}