---
title: "Create a Pay By Link"
method: POST
path: "/pay-by-link"
tags: ["Pay By Link"]
---

# Create a Pay By Link

`POST /pay-by-link`

## Request

- Base URL: `https://api.cloudbeds.com/payments/v2`
- URL: `https://api.cloudbeds.com/payments/v2/pay-by-link`
- Auth: HTTP bearer

## Headers

- `X-Property-Id` string, required

## Request body

- PblCreateRequest: Request model for creating a new pay-by-link payment request
  - `paid` number, double, required: The amount to charge via the payment link. Must be greater than 0
  - `description` string, nullable: Description of the created payment posted to folio. Explains what the payment is for
  - `inventoryObject` InventoryObjectCreateRequest, required: Inventory object that the payment is associated with.
    - `type` string, required: The inventory object type. This may be `confirmation_number`, `group_profile`, `house_account`, `reservation`, or `reservation_room`. `confirmation_number` should be used when referencing the external reservation ID from the Cloudbeds API.
    - `id` string, required: The ID of the inventory object.
  - `propertyId` string: The property ID associated with the inventory object. Must be a valid Cloudbeds property ID
  - `folio_id` integer, 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_after` integer: Number of days the payment link remains valid. Maximum 30 days
  - `auth_payment` boolean: Payment capture method. Set to false for immediate payment collection, true for card authorization only (capture later via PMS UI)

## Response `200`

Successfully created pay by link

- PblCreateResponse: Response model returned after successfully creating a pay-by-link payment request
  - `url` string, uri, required: The payment link URL to send to the customer. This URL directs them to the secure payment page
  - `id` string, uuid, required: Unique identifier (UUID) for the created payment link. Use this to track and manage the payment link
  - `expires_at` string, date-time, required: Expiration date and time for the payment link. After this time, the link will no longer accept payments

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `500`: Internal Server Error

---

[API](https://skmtc.dev/cloudbeds/apis/pay-by-link-api.md) - [All operations](https://skmtc.dev/cloudbeds/apis/pay-by-link-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/pay-by-link-api/revisions/b0969e81432b?raw)