API Reference

Create a Pay By Link

post
https://api.cloudbeds.com/payments/v2/pay-by-link
Body Params
double
required
> 0

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

string | null

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

inventoryObject
object
required

Inventory object that the payment is associated with.

string

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

int64 | null
≥ 0

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

int32
0 to 30
Defaults to 7

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

boolean
Defaults to false

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

Headers
string
required

The property ID of the client

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago