Optimizely

Optimizely Payment Methods API

The Payment Methods API from Optimizely — 7 operation(s) for payment methods.

GitHub OpenAPI

Operations 11

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/PaymentMethods List payment methods · Returns the EntitySet PaymentMethods #
Ask an LLM
“Which payment methods are configured for checkout?”
“Can I filter payment methods to only credit card types?”
Tell an agent
List all payment methods.
Show payment methods matching {filter}.
POST /api/v1/admin/PaymentMethods Create a payment method · Post a new entity to EntitySet PaymentMethods #
Ask an LLM
“How do I add a new payment option like buy now pay later?”
“Can I schedule a payment method to activate on a future date?”
Tell an agent
Create payment method {name} described as {description}.
Add credit card payment method {name}, {description}, active from {activateOn}.
GET /api/v1/admin/PaymentMethods({id}) Get a payment method · Returns the entity with the key from PaymentMethods #
Ask an LLM
“Is a given payment method a credit card, eCheck or BNPL option?”
“Can I look up one payment method by its ID?”
Tell an agent
Get payment method {id}.
Show the type flags for payment method {id}.
PUT /api/v1/admin/PaymentMethods({id}) Replace a payment method entirely · Replace entity in EntitySet PaymentMethods #
Ask an LLM
“How do I overwrite every field of a payment method?”
“Can I fully replace a payment method record?”
Tell an agent
Replace payment method {id} with name {name} and description {description}.
Overwrite all fields of payment method {id}: {name}, {description}.
DELETE /api/v1/admin/PaymentMethods({id}) Delete a payment method · Delete entity in EntitySet PaymentMethods #
Ask an LLM
“How do I permanently delete one payment method?”
“Does deleting a payment method honor an If-Match header?”
Tell an agent destructive · confirm first
Delete payment method {id}.
Remove payment method {id} if its ETag is {ifMatch}.
PATCH /api/v1/admin/PaymentMethods({id}) Update some fields of a payment method · Update entity in EntitySet PaymentMethods #
Ask an LLM
“How do I set a deactivation date on a payment method?”
“Can I rename a payment method without replacing it?”
Tell an agent
Set deactivate date {deactivateOn} on payment method {id} named {name} with description {description}.
Rename payment method {id} to {name} with description {description}.
GET /api/v1/admin/PaymentMethods/Default.Default() Get default values for a new payment method · Call operation Default #
Ask an LLM
“What defaults does a new payment method start with?”
“Is there a blank payment method template?”
Tell an agent
Get the default field values for a new payment method.
Show a blank payment method record.
POST /api/v1/admin/PaymentMethods/Default.archive Archive payment methods via the archive action · Call operation archive #
Ask an LLM
“How do I archive payment methods with the POST archive action?”
“Can I retire payment methods without deleting them?”
Tell an agent
Archive payment methods {ids} with the archive action.
Run the POST archive action on payment methods {ids}.
DELETE /api/v1/admin/paymentmethods/archive Archive payment methods via the DELETE route · Payment methods archive route #
Ask an LLM
“Is there a DELETE archive endpoint for payment methods?”
“Which route archives payment methods using the DELETE method?”
Tell an agent destructive · confirm first
Archive payment methods {ids} through the DELETE archive route.
Call DELETE paymentmethods/archive for {ids}.
DELETE /api/v1/admin/paymentmethods/delete Delete several payment methods · Payment methods delete route #
Ask an LLM
“How do I bulk delete a list of payment methods permanently?”
“Can I delete many payment methods in one request?”
Tell an agent destructive · confirm first
Bulk delete payment methods {ids}.
Permanently delete every payment method in {ids}.
GET /api/v1/admin/paymentmethods({key})/customproperties({custompropertyKey}) Get a custom property on a payment method · Payment methods get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property on a payment method?”
“Can I fetch one custom field value from a payment method?”
Tell an agent
Get custom property {custompropertyKey} of payment method {key}.
Show the {custompropertyKey} custom property on payment method {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-payment-methods-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-payment-methods-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-payment-methods-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Payment Methods API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Payment Methods
paths:
  /api/v1/admin/PaymentMethods:
    get:
      tags:
      - Payment Methods
      summary: Returns the EntitySet PaymentMethods
      operationId: PaymentMethods_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:
      - Payment Methods
      summary: Post a new entity to EntitySet PaymentMethods
      operationId: PaymentMethods_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PaymentMethod'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PaymentMethods({id}):
    get:
      tags:
      - Payment Methods
      summary: Returns the entity with the key from PaymentMethods
      operationId: PaymentMethods_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:
      - Payment Methods
      summary: Replace entity in EntitySet PaymentMethods
      operationId: PaymentMethods_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.PaymentMethod'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Payment Methods
      summary: Delete entity in EntitySet PaymentMethods
      operationId: PaymentMethods_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:
      - Payment Methods
      summary: Update entity in EntitySet PaymentMethods
      operationId: PaymentMethods_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.PaymentMethod'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PaymentMethods/Default.Default():
    get:
      tags:
      - Payment Methods
      summary: Call operation Default
      operationId: PaymentMethods_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PaymentMethods/Default.archive:
    post:
      tags:
      - Payment Methods
      summary: Call operation archive
      operationId: PaymentMethods_Archive
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      requestBody:
        $ref: '#/components/requestBodies/Affiliates_ArchiveParameters'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/paymentmethods/archive:
    delete:
      tags:
      - Payment Methods
      operationId: PaymentMethods_ArchiveRoute
      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: Payment methods archive route
      x-summary-source: derived
  /api/v1/admin/paymentmethods/delete:
    delete:
      tags:
      - Payment Methods
      operationId: PaymentMethods_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: Payment methods delete route
      x-summary-source: derived
  /api/v1/admin/paymentmethods({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Payment Methods
      operationId: PaymentMethods_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: Payment methods get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.PaymentMethod:
      required:
      - description
      - name
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        activateOn:
          format: date-time
          type: string
        deactivateOn:
          format: date-time
          type: string
        description:
          maxLength: 100
          minLength: 0
          type: string
        isCreditCard:
          type: boolean
        iseCheck:
          type: boolean
        isBnpl:
          type: boolean
        name:
          maxLength: 50
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  requestBodies:
    Affiliates_ArchiveParameters:
      content:
        application/json:
          schema:
            type: object
            properties: {}
      description: archive action parameters
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query