CLcloudbeds
Payment

postVoidPayment

Voids a payment (using paymentID) to a specified reservation or house account.

post/postVoidPayment

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postVoidPayment
  • 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

paymentIDstring

paymentID of transaction that should be voided.

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

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

Changes

No recorded changes to this operation across all 2 revisions of this API.