APapaleo
Authorization

Returns a single authorization by ID

Changed on

<br>You must have at least one of these scopes: 'authorizations.read, authorizations.manage'.<br>For fine-grained clients, you must have this permission: 'core.authorizations.read'.

get/booking/v1/authorizations/{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/booking/v1/authorizations/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: authorizations.read, authorizations.manage, admin

Path parameters

idstring required

The identifier of the authorization

Query parameters

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.

Response

Successfully returned authorization

idstring required

Authorization id

createdstring date-time required

Date of creation<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

updatedstring date-time required

Date of last modification<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

status'Pending' | 'Success' | 'Failure' | 'Canceled' | 'Expired' | 'RefreshPending' required

Status of the authorization

failureReasonstring nullable

Human-readable failure reason

payerInteraction'Terminal' | 'PaymentAccount' | 'Authorization' | 'PaymentLink' required

Payer interaction of the authorization

expiresAtstring date-time nullable

The date and time the authorization expires<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

paymentLinkUrlstring nullable

The URL to the payment link when authorization is created by payment link

Example response

{
  "id": "IUSENHBB",
  "target": {
    "type": "Booking",
    "id": "KYKXKLWL",
    "propertyId": "MUC"
  },
  "created": "2026-10-16T03:03:14.2942377Z",
  "updated": "2026-10-16T03:03:14.2942395Z",
  "externalReference": {
    "paymentTransactionId": "VT6G6BFUR6XE5MHZARAX2ODK7Y"
  },
  "amount": {
    "amount": 150,
    "currency": "EUR"
  },
  "remainingBalance": {
    "amount": 100,
    "currency": "EUR"
  },
  "status": "Success",
  "payerInteraction": "PaymentAccount",
  "expiresAt": "2026-11-15T03:03:14.2942401Z",
  "actions": [
    {
      "action": "Cancel",
      "isAllowed": false,
      "reasons": [
        {
          "code": "OnlySuccessfulAuthorizationCanBeCanceled",
          "message": "Only a successful authorization can be canceled."
        }
      ]
    },
    {
      "action": "Refresh",
      "isAllowed": true
    },
    {
      "action": "ExpirePaymentLink",
      "isAllowed": false,
      "reasons": [
        {
          "code": "OnlyPendingPaymentLinkAuthorizationCanBeExpired",
          "message": "Only pending payment link authorization can be expired."
        }
      ]
    }
  ]
}

Changes