Optimizely

Optimizely Credit Card Transactions API

The Credit Card Transactions API from Optimizely — 5 operation(s) for credit card transactions.

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/CreditCardTransactions List credit card transactions · Returns the EntitySet CreditCardTransactions #
Ask an LLM
“Which credit card authorizations and captures has my store processed?”
“Can I filter card transactions by order number or result and get a count?”
Tell an agent
List all credit card transactions.
List card transactions matching {filter}, newest first by {orderby}.
POST /api/v1/admin/CreditCardTransactions Record a credit card transaction · Post a new entity to EntitySet CreditCardTransactions #
Ask an LLM
“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?”
Tell an agent
Record a {transactionType} card transaction for order {orderNumber} with auth code {authCode}.
Log a {amount} card charge for customer {customerNumber} with status {status}.
GET /api/v1/admin/CreditCardTransactions({id}) Get one credit card transaction · Returns the entity with the key from CreditCardTransactions #
Ask an LLM
“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?”
Tell an agent
Get credit card transaction {id}.
Show only {select} for card transaction {id}.
PUT /api/v1/admin/CreditCardTransactions({id}) Replace a credit card transaction record · Replace entity in EntitySet CreditCardTransactions #
Ask an LLM
“How do I overwrite a card transaction record with a full set of fields?”
“Does replacing a card transaction mean resending every gateway field?”
Tell an agent
Replace card transaction {id} with result {result} and status {status}.
Fully overwrite credit card transaction {id} for order {orderNumber}.
DELETE /api/v1/admin/CreditCardTransactions({id}) Delete a credit card transaction record · Delete entity in EntitySet CreditCardTransactions #
Ask an LLM
“How do I remove a card transaction record from the admin data?”
“Can I require an ETag match before deleting a card transaction?”
Tell an agent destructive · confirm first
Delete credit card transaction {id}.
Delete card transaction {id} only if ETag {ifMatch} matches.
PATCH /api/v1/admin/CreditCardTransactions({id}) Update fields on a card transaction · Update entity in EntitySet CreditCardTransactions #
Ask an LLM
“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?”
Tell an agent
Mark card transaction {id} as posted to ERP: {postedToErp}.
Set invoice number {invoiceNumber} on card transaction {id}.
GET /api/v1/admin/CreditCardTransactions/Default.Default() Call the Default function on card transactions · Call operation Default #
Ask an LLM
“What does the Default OData function on credit card transactions return?”
“Is there a default card transaction entity I can read?”
Tell an agent
Call the Default function on credit card transactions.
Get the default credit card transaction entity.
DELETE /api/v1/admin/creditcardtransactions/delete Bulk delete credit card transactions · Credit card transactions delete route #
Ask an LLM
“Can I delete several card transaction records at once?”
“How do I purge a list of card transactions by ID?”
Tell an agent destructive · confirm first
Bulk delete credit card transactions {ids}.
Purge these card transaction records: {ids}.
GET /api/v1/admin/creditcardtransactions({key})/customproperties({custompropertyKey}) Get a custom property on a card transaction · Credit card transactions get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a credit card transaction?”
“Can card transactions carry extra custom fields?”
Tell an agent
Get custom property {custompropertyKey} of card transaction {key}.
Read custom field {custompropertyKey} on credit card transaction {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-credit-card-transactions-api-openapi.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-credit-card-transactions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-credit-card-transactions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Credit Card Transactions API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Credit Card Transactions
paths:
  /api/v1/admin/CreditCardTransactions:
    get:
      tags:
      - Credit Card Transactions
      summary: Returns the EntitySet CreditCardTransactions
      operationId: CreditCardTransactions_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Credit Card Transactions
      summary: Post a new entity to EntitySet CreditCardTransactions
      operationId: CreditCardTransactions_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CreditCardTransaction'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CreditCardTransactions({id}):
    get:
      tags:
      - Credit Card Transactions
      summary: Returns the entity with the key from CreditCardTransactions
      operationId: CreditCardTransactions_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Credit Card Transactions
      summary: Replace entity in EntitySet CreditCardTransactions
      operationId: CreditCardTransactions_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CreditCardTransaction'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Credit Card Transactions
      summary: Delete entity in EntitySet CreditCardTransactions
      operationId: CreditCardTransactions_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Credit Card Transactions
      summary: Update entity in EntitySet CreditCardTransactions
      operationId: CreditCardTransactions_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CreditCardTransaction'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CreditCardTransactions/Default.Default():
    get:
      tags:
      - Credit Card Transactions
      summary: Call operation Default
      operationId: CreditCardTransactions_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/creditcardtransactions/delete:
    delete:
      tags:
      - Credit Card Transactions
      operationId: CreditCardTransactions_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Credit card transactions delete route
      x-summary-source: derived
  /api/v1/admin/creditcardtransactions({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Credit Card Transactions
      operationId: CreditCardTransactions_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Credit card transactions get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.CreditCardTransaction:
      required:
      - transactionType
      - result
      - authCode
      - pnRef
      - respMsg
      - respText
      - avsAddr
      - avsZip
      - avsResponse
      - cvv2Match
      - requestId
      - requestString
      - responseString
      - status
      - creditCardNumber
      - name
      - expirationDate
      - orderNumber
      - shipmentNumber
      - customerNumber
      - site
      - origId
      - bankCode
      - cardType
      - invoiceNumber
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerOrderId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        transactionType:
          maxLength: 50
          minLength: 0
          type: string
        transactionDate:
          format: date-time
          type: string
        result:
          maxLength: 50
          minLength: 0
          type: string
        authCode:
          maxLength: 200
          minLength: 0
          type: string
        pnRef:
          maxLength: 256
          minLength: 0
          type: string
        respMsg:
          maxLength: 1024
          minLength: 0
          type: string
        respText:
          maxLength: 1024
          minLength: 0
          type: string
        avsAddr:
          maxLength: 250
          minLength: 0
          type: string
        avsZip:
          maxLength: 50
          minLength: 0
          type: string
        avsResponse:
          maxLength: 500
          minLength: 0
          type: string
        cvv2Match:
          maxLength: 50
          minLength: 0
          type: string
        requestId:
          maxLength: 100
          minLength: 0
          type: string
        requestString:
          type: string
        responseString:
          type: string
        amount:
          format: decimal
          type: number
        status:
          maxLength: 50
          minLength: 0
          type: string
        creditCardNumber:
          maxLength: 50
          minLength: 0
          type: string
        name:
          maxLength: 50
          minLength: 0
          type: string
        expirationDate:
          maxLength: 50
          minLength: 0
          type: string
        orderNumber:
          maxLength: 50
          minLength: 0
          type: string
        shipmentNumber:
          maxLength: 50
          minLength: 0
          type: string
        customerNumber:
          maxLength: 50
          minLength: 0
          type: string
        site:
          maxLength: 50
          minLength: 0
          type: string
        origId:
          maxLength: 100
          minLength: 0
          type: string
        bankCode:
          maxLength: 50
          minLength: 0
          type: string
        token1:
          maxLength: 200
          minLength: 0
          type: string
        token2:
          maxLength: 200
          minLength: 0
          type: string
        gatewayProfileId:
          maxLength: 200
          minLength: 0
          type: string
        cardType:
          maxLength: 200
          minLength: 0
          type: string
        postedToErp:
          type: boolean
        invoiceNumber:
          maxLength: 50
          minLength: 0
          type: string
        currencyId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        currencyAmount:
          format: double
          type: number
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query