CLcloudbeds
Payment

postCharge

Changed on

Use a payment method to process a payment on a reservation, group profile, accounts receivable ledger, or house account.

post/postCharge

Request

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

Request body application/x-www-form-urlencoded

propertyIDstring
reservationIDstring nullable

Reservation ID

houseAccountIDstring nullable

House Account ID

eventIDstring nullable

Event (group profile) ID

accountsReceivableLedgerIDstring nullable

Accounts Receivable Ledger ID

amountstring

Amount to charge

currencystring

Currency to charge

descriptionstring

Description of the payment to display on folio

cardTokenstring nullable

cardToken provided by Cloudbeds vault

paymentMethodIdstring nullable

Payment method UUID

isDepositboolean nullable

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

redirectUrlstring nullable

client will be redirected to this page after he completed 3ds challenge. User will be redirected with HTTP get redirect and parameter result will be added to query string with possible values: - failed if 3ds challenge is not passed - successful if 3ds challenge is passed If not provided for card with 3ds the request will be rejected

Response

200 Response

successboolean

Returns if the request was completed

Changes

  • 6f4f997d5f7aRevision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status