---
title: "Retrieve a Pay By Link"
method: GET
path: "/pay-by-link/{uuid}"
tags: ["Pay By Link"]
---

# Retrieve a Pay By Link

`GET /pay-by-link/{uuid}`

## Path parameters

- `uuid` string, required

## Headers

- `X-Property-Id` string, required

## Response `200`

The pay by link associated to the UUID

- PblGetResponse — Response model containing detailed information about a pay-by-link payment request
  - `id` string, uuid, required — Unique identifier (UUID) of the payment link
  - `propertyId` integer, required — The Cloudbeds property ID this payment link is associated with
  - `folioId` integer, nullable — The folio ID this payment link is associated with. May be null, 0, or indicate the default folio
  - `payByLinkStatus` 'SENT' | 'VIEWED' | 'PAID' | 'EXPIRED' | 'CANCELLED' | '3DSPROCESSING', required — Current status of the payment link
  - `completedAt` string, date-time, nullable — Timestamp when the payment was completed. Null if payment is not yet complete
  - `expiresAt` string, date-time, required — Timestamp when the payment link will expire and no longer accept payments
  - `createdAt` string, date-time, required — Timestamp when the payment link was created
  - `captureMethod` CaptureMethod, required — Payment capture method. `charge` for immediate payment, `auth` for authorization only
    - `paymentMethod` string
    - `captureMethod` string
  - `cost` Money, required — Payment amount and currency details
    - `value` number, double
    - `currency` string
  - `notes` string, nullable — Description of the created payment posted to folio. Explains what the payment is for
  - `expired` boolean, required — Indicates whether the payment link has expired
  - `paid` boolean, required — Indicates whether the payment has been completed
  - `readyForPayment` boolean, required — Indicates whether the payment link is active and ready to accept payments

## Other responses

- `400` — Pay By Link not found
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)