Optimizely · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Admin API V1 Credit Card Transactions API
10 actions
10 updates
phrasing
extends
openapi/optimizely-credit-card-transactions-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/api/v1/admin/CreditCardTransactions'].get
$.paths['/api/v1/admin/CreditCardTransactions'].post
$.paths['/api/v1/admin/CreditCardTransactions({id})'].get
$.paths['/api/v1/admin/CreditCardTransactions({id})'].put
$.paths['/api/v1/admin/CreditCardTransactions({id})'].delete
$.paths['/api/v1/admin/CreditCardTransactions({id})'].patch
$.paths['/api/v1/admin/CreditCardTransactions/Default.Default()'].get
$.paths['/api/v1/admin/creditcardtransactions/delete'].delete
$.paths['/api/v1/admin/creditcardtransactions({key})/customproperties({custompropertyKey})'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Admin API V1 Credit Card Transactions API
version: 1.0.0
extends: openapi/optimizely-credit-card-transactions-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: 9
- target: $.paths['/api/v1/admin/CreditCardTransactions'].get
update:
x-apievangelist-phrasing:
intent: List credit card transactions
effect: read
questions:
- Which credit card authorizations and captures has my store processed?
- Can I filter card transactions by order number or result and get a count?
instructions:
- text: List all credit card transactions.
- text: List card transactions matching {filter}, newest first by {orderby}.
slots:
filter: query.$filter
orderby: query.$orderby
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CreditCardTransactions'].post
update:
x-apievangelist-phrasing:
intent: Record a credit card transaction
effect: write
questions:
- How do I log a gateway card transaction against an order?
- What gateway response fields like auth code and AVS result are required to record a card transaction?
instructions:
- text: Record a {transactionType} card transaction for order {orderNumber} with auth code {authCode}.
slots:
transactionType: requestBody.transactionType
orderNumber: requestBody.orderNumber
authCode: requestBody.authCode
- text: Log a {amount} card charge for customer {customerNumber} with status {status}.
slots:
amount: requestBody.amount
customerNumber: requestBody.customerNumber
status: requestBody.status
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CreditCardTransactions({id})'].get
update:
x-apievangelist-phrasing:
intent: Get one credit card transaction
effect: read
questions:
- How do I pull up the gateway response for a single card transaction?
- Can I see the AVS and CVV results of one credit card transaction?
instructions:
- text: Get credit card transaction {id}.
slots:
id: path.id
- text: Show only {select} for card transaction {id}.
slots:
select: query.$select
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CreditCardTransactions({id})'].put
update:
x-apievangelist-phrasing:
intent: Replace a credit card transaction record
effect: write
questions:
- How do I overwrite a card transaction record with a full set of fields?
- Does replacing a card transaction mean resending every gateway field?
instructions:
- text: Replace card transaction {id} with result {result} and status {status}.
slots:
id: path.id
result: requestBody.result
status: requestBody.status
- text: Fully overwrite credit card transaction {id} for order {orderNumber}.
slots:
id: path.id
orderNumber: requestBody.orderNumber
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CreditCardTransactions({id})'].delete
update:
x-apievangelist-phrasing:
intent: Delete a credit card transaction record
effect: destructive
questions:
- How do I remove a card transaction record from the admin data?
- Can I require an ETag match before deleting a card transaction?
instructions:
- text: Delete credit card transaction {id}.
slots:
id: path.id
- text: Delete card transaction {id} only if ETag {ifMatch} matches.
slots:
id: path.id
ifMatch: header.If-Match
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CreditCardTransactions({id})'].patch
update:
x-apievangelist-phrasing:
intent: Update fields on a card transaction
effect: write
questions:
- Can I flag a card transaction as posted to the ERP without touching anything else?
- How do I attach an invoice number to an existing card transaction?
instructions:
- text: 'Mark card transaction {id} as posted to ERP: {postedToErp}.'
slots:
id: path.id
postedToErp: requestBody.postedToErp
- text: Set invoice number {invoiceNumber} on card transaction {id}.
slots:
invoiceNumber: requestBody.invoiceNumber
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CreditCardTransactions/Default.Default()'].get
update:
x-apievangelist-phrasing:
intent: Call the Default function on card transactions
effect: read
questions:
- What does the Default OData function on credit card transactions return?
- Is there a default card transaction entity I can read?
instructions:
- text: Call the Default function on credit card transactions.
- text: Get the default credit card transaction entity.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/creditcardtransactions/delete'].delete
update:
x-apievangelist-phrasing:
intent: Bulk delete credit card transactions
effect: destructive
questions:
- Can I delete several card transaction records at once?
- How do I purge a list of card transactions by ID?
instructions:
- text: Bulk delete credit card transactions {ids}.
slots:
ids: query.ids
- text: 'Purge these card transaction records: {ids}.'
slots:
ids: query.ids
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/creditcardtransactions({key})/customproperties({custompropertyKey})'].get
update:
x-apievangelist-phrasing:
intent: Get a custom property on a card transaction
effect: read
questions:
- How do I read a custom property stored on a credit card transaction?
- Can card transactions carry extra custom fields?
instructions:
- text: Get custom property {custompropertyKey} of card transaction {key}.
slots:
custompropertyKey: path.custompropertyKey
key: path.key
- text: Read custom field {custompropertyKey} on credit card transaction {key}.
slots:
custompropertyKey: path.custompropertyKey
key: path.key
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/optimizely-credit-card-transactions-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
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.
A second provider on the same verified email joins the account you already have.