APapaleo
CapturePolicies

Get a specific capture policy.

Get a specific capture policy.<br>You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.

get/settings/v1/capture-policies/{id}

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/settings/v1/capture-policies/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: settings.read, setup.read, setup.manage, admin

Path parameters

idstring required

The ID of the capture policy.

Response

Success.

idstring required

The ID of the capture policy

codestring nullable

The code of the capture policy

captureNoShowFeeboolean required

Specify whether the no-show fee should be captured automatically, when a reservation is set to no-show

captureCancellationFeeboolean required

Specify whether the cancellation fee should be captured automatically, when a reservation is cancelled

capturePrepaymentboolean required

Specify if prepayments should be captured automatically, when a reservation is created or its payment account changed

postOtaBankTransferOnCheckOutboolean required

Specify if reservations coming from source or channel Booking.com will be automatically marked as paid on check-out. Caution: only select this, if you configured Booking.com > Finance to be 'Payments by Booking.com'

capturePayment'Manual' | 'CheckIn' | 'CheckOut' required

Specify if and when payments should be captured automatically.

propertyIdstring required

The property this capture policy is valid for

Example response

{
  "id": "MUC-CAP",
  "code": "CAP",
  "captureNoShowFee": false,
  "captureCancellationFee": false,
  "capturePrepayment": true,
  "postOtaBankTransferOnCheckOut": false,
  "capturePayment": "CheckOut",
  "propertyId": "MUC"
}

Changes

No recorded changes to this operation across all 1 revision of this API.