Property: Cancellation Policies

Retrieve Cancellation and Payment Policies

get

Through this call you can retrieve all the Policies set in the Octorate Platform.

Authorizations

OAuth2authorizationCodeRequired

When you're interacting with an Accommodation/Network you should use this access. Octorate default authentication model to access all the resources relative to an Accommodation. One token = 1 property or the network properties of the ones user has visibility. [More info] https://partner.octorate.com/integration/showcases/authentication.html

Authorization URL: Token URL: Refresh URL:

Path parameters

accommodationstringRequired

Responses

200

Processed

application/json

Cancellation Policy / Payment Policy

idinteger · int64Read-onlyOptional

Id of the payment step

Example: 12

stepTypestring · enumRequired

Payment Step Type

Example: CANCELLATIONPossible values:

disabledbooleanOptional

Indicates if the payment step is disabled

Example: true

codicestringOptional

Indicates the code of accommodation

Example: 123456

ignoreRatePlanbooleanOptional

True if this step is ignored by rate plan

accommodationIdstringRequired

Id of the accommodation

Example: 123456

titlestringRequiredExample: Refundable 30 days

daysinteger · int32Optional

Number of days for the condition

Example: 30

beforeCheckinbooleanOptional

True if the condition is before check-in

Example: true

notRefundablebooleanOptional

True if the condition is non-refundable

Example: true

newReservationsbooleanOptional

True if the rule applies only to new reservations

Example: true

chargeCreditCardbooleanOptional

True if the credit card will be charged

Example: true

valueFixednumberOptional

Fixed value to charge

Example: 100

valuePercentinteger · int32Optional

Percentage value to charge

Example: 50

valueNightsinteger · int32Optional

Number of nights to charge

Example: 2

templateIdinteger · int64Optional

ID of the template used

Example: 101

templateNotifyinteger · int64Optional

ID of the notification template

Example: 102

checkinFromstring · date-timeOptional

Start date of valid check-in

checkinTostring · date-timeOptional

End date of valid check-in

createdFromstring · date-timeOptional

Start date when the rule is active

createdTostring · date-timeOptional

End date when the rule is active

vccbooleanOptional

True if Virtual Credit Card is supported

Example: true

hourstringOptional

Specific hour for applying the rule

Example: 16:00

roomIdsstring[]Optional

List of room IDs the rule applies to

portalNamesstring[]Optional

List of portal names the rule applies to

refundAfterDaysinteger · int32Optional

The number of days after which the reservation will be refunded

Example: 30

400

Invalid Request

401

There is something wrong with you api key

403

Access to the resource is forbidden

500

Internal Server Error, something bad occourend on Octorate side

get/rest/v1/policies/{accommodation}

GET /connect/rest/v1/policies/{accommodation} HTTP/1.1
Host: api.octorate.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 1932,
      "stepType": "PAYMENT",
      "title": "Bank cash"
    },
    {
      "id": 8718,
      "stepType": "PAYMENT",
      "title": "test money"
    },
    {
      "id": 11450,
      "stepType": "PAYMENT",
      "title": "30 Days Before, take money"
    },
    {
      "id": 11451,
      "stepType": "PAYMENT",
      "title": "saldo"
    },
    {
      "id": 4478,
      "stepType": "CANCELLATION",
      "title": "50% - 10 days prior to checkin"
    }
  ]
}