CLcloudbeds
Payment

postPayment

Changed on

Add a payment to a specified reservation, house account, or group. If multiple IDs are provided, precedence is reservationID, then houseAccountID, then eventCode.

post/postPayment

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postPayment
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: write:payment

Request body application/x-www-form-urlencoded

propertyIDstring nullable

Property ID

reservationIDstring

Reservation identifier

houseAccountIDstring

House Account identifier is necessary if reservationID not sent

eventCodestring

Event (group profile) code. Required if neither reservationID nor houseAccountID is sent

subReservationIDstring nullable

The Sub Reservation identifier. reservationID is still mandatory if subReservationID is sent.

typestring

Payment type. Use the call getPaymentMethods to get the properties enabled payment methods.

amountnumber

Amount paid on this transaction

cardTypestring

If type = credit, cardType is necessary. Allowed values are property based, but possible strings are: "visa","master","amex","aura","diners","hiper","elo","Discover","jcb","maestro","dan","PostCard","Eurocard","union_pay"

descriptionstring nullable

Note to be added to payment

isDepositboolean nullable

determine if this payment is a deposit (default: false)

Response

200 Response

successboolean

Returns if the request could be completed

paymentIDstring

Returns paymentID of transaction

transactionIDstring

Returns transactionID

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes