Payment

postCustomPaymentMethod

Add a Custom Payment Method to a property. This call does not allow to add Payment Methods: credit cards, bank transfer or Pay Pal.

post/postCustomPaymentMethod

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postCustomPaymentMethod
  • 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, if not sent will retrieve property ID from credentials, only one property ID call.

methodstring

Payment Method, value used in future calls. Must be unique for each property and no whitespaces are allowed (use camel case or underline instead). Will be verified against existing Payment Methods, if it exists, will try to enable it.

methodNamestring nullable

Payment Method Name, value used to represent the Payment Method. Can use spaces. If nothing is sent, will use value for method.

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.