Generated by API Evangelist
Written by API Evangelist tooling for Oracle Hospitality's API. It is a proposal applied on top of the contract, not a document Oracle Hospitality publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Oracle Hospitality Hotels API
version: 1.0.0
extends: openapi/oracle-hospitality-hotels-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/hotels/{hotelCode}/tokenizations'].post
update:
x-apievangelist-phrasing:
intent: Start an e-commerce card tokenization transaction
effect: write
questions:
- How do I start a card tokenization session through the e-commerce token form for a hotel?
- What origin domain and locale does the tokenization form need when I initiate it?
instructions:
- text: Initiate an e-commerce tokenization transaction for hotel {hotelCode} from origin {originDomain} in locale {locale}.
slots:
hotelCode: path.hotelCode
originDomain: requestBody.originDomain
locale: requestBody.locale
- text: Open a hosted card token form for hotel {hotelCode} using bearer token {Authorization}, domain {originDomain}, locale {locale}.
slots:
hotelCode: path.hotelCode
Authorization: header.Authorization
originDomain: requestBody.originDomain
locale: requestBody.locale
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/tokenizations/{transactionId}'].get
update:
x-apievangelist-phrasing:
intent: Check the result of an e-commerce tokenization
effect: read
questions:
- Did the guest's card tokenization through the e-commerce form finish successfully?
- Where do I get the final status and details of a tokenization transaction?
instructions:
- text: Fetch the status of tokenization transaction {transactionId} at hotel {hotelCode}.
slots:
transactionId: path.transactionId
hotelCode: path.hotelCode
- text: Get the final e-commerce token form outcome for transaction {transactionId}, hotel {hotelCode}, with token {Authorization}.
slots:
transactionId: path.transactionId
hotelCode: path.hotelCode
Authorization: header.Authorization
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/tokens'].post
update:
x-apievangelist-phrasing:
intent: Exchange a card number for a payment token
effect: write
questions:
- Can I convert a raw card number into a token from the payment service provider?
- What do I need to send to tokenize a PAN directly without the hosted form?
instructions:
- text: Tokenize card number {pan} expiring {expiryDate} for hotel {hotelCode}.
slots:
pan: requestBody.pan
expiryDate: requestBody.expiryDate
hotelCode: path.hotelCode
- text: Swap PAN {pan} with expiry {expiryDate} for a PSP-issued token at hotel {hotelCode}.
slots:
pan: requestBody.pan
expiryDate: requestBody.expiryDate
hotelCode: path.hotelCode
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.