Commerce Layer payment_methods API

resource type

Operations 5

GET /payment_methods List all payment methods #
POST /payment_methods Create a payment method #
GET /payment_methods/{paymentMethodId} Retrieve a payment method #
PATCH /payment_methods/{paymentMethodId} Update a payment method #
DELETE /payment_methods/{paymentMethodId} Delete a payment method #

Documentation

Specifications

Schemas & Data

Other Resources

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/commerce-layer-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 email required.

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

OpenAPI Specification

commerce-layer-payment-methods-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Commerce Layer Payment Methods API
  version: 7.10.1
  contact:
    name: API Support
    url: https://commercelayer.io
    email: support@commercelayer.io
  description: Headless Commerce for Global Brands.
servers:
- url: https://{your_organization_slug}.commercelayer.io/api
  description: API
- url: https://core.commercelayer.io/users/sign_in
  description: Sign in
- url: https://docs.commercelayer.io/api
  description: API reference
security:
- bearerAuth: []
tags:
- name: payment_methods
  description: resource type
paths:
  /payment_methods:
    get:
      operationId: GET/payment_methods
      summary: List all payment methods
      description: List all payment methods
      tags:
      - payment_methods
      responses:
        '200':
          description: A list of payment method objects
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/paymentMethodResponseList'
    post:
      operationId: POST/payment_methods
      summary: Create a payment method
      description: Create a payment method
      tags:
      - payment_methods
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/paymentMethodCreate'
      responses:
        '201':
          description: The created payment method object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/paymentMethodResponse'
  /payment_methods/{paymentMethodId}:
    get:
      operationId: GET/payment_methods/paymentMethodId
      summary: Retrieve a payment method
      description: Retrieve a payment method
      tags:
      - payment_methods
      parameters:
      - name: paymentMethodId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The payment method object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/paymentMethodResponse'
    patch:
      operationId: PATCH/payment_methods/paymentMethodId
      summary: Update a payment method
      description: Update a payment method
      tags:
      - payment_methods
      parameters:
      - name: paymentMethodId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/paymentMethodUpdate'
      responses:
        '200':
          description: The updated payment method object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/paymentMethodResponse'
    delete:
      operationId: DELETE/payment_methods/paymentMethodId
      summary: Delete a payment method
      description: Delete a payment method
      tags:
      - payment_methods
      parameters:
      - name: paymentMethodId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '204':
          description: No content
components:
  schemas:
    paymentMethodUpdate:
      required:
      - data
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - id
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - payment_methods
            id:
              type: string
              description: Unique identifier for the resource (hash).
              example: XAyRWNUzyN
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The payment method's internal name.
                  example: Stripe Payment
                  nullable: true
                payment_source_type:
                  type: string
                  description: The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
                  example: stripe_payments
                  nullable: false
                  enum:
                  - adyen_payments
                  - axerve_payments
                  - braintree_payments
                  - checkout_com_payments
                  - external_payments
                  - klarna_payments
                  - paypal_payments
                  - satispay_payments
                  - stripe_payments
                  - wire_transfers
                currency_code:
                  type: string
                  description: The international 3-letter currency code as defined by the ISO 4217 standard.
                  example: EUR
                  nullable: true
                moto:
                  type: boolean
                  description: Send this attribute if you want to mark the payment as MOTO, must be supported by payment gateway.
                  example: false
                  nullable: false
                require_capture:
                  type: boolean
                  description: Send this attribute if you want to require the payment capture before fulfillment.
                  example: true
                  nullable: false
                auto_place:
                  type: boolean
                  description: Send this attribute if you want to automatically place the order upon authorization performed asynchronously.
                  example: true
                  nullable: false
                auto_capture:
                  type: boolean
                  description: Send this attribute if you want to automatically capture the payment upon authorization.
                  example: false
                  nullable: false
                price_amount_cents:
                  type: integer
                  description: The payment method's price, in cents.
                  example: 0
                  nullable: false
                auto_capture_max_amount_cents:
                  type: integer
                  description: Send this attribute if you want to limit automatic capture to orders for which the total amount is equal or less than the specified value, in cents.
                  example: 0
                  nullable: true
                _disable:
                  type: boolean
                  description: Send this attribute if you want to mark this resource as disabled.
                  example: true
                  nullable: false
                _enable:
                  type: boolean
                  description: Send this attribute if you want to mark this resource as enabled.
                  example: true
                  nullable: false
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                  nullable: true
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                  nullable: true
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
                  nullable: true
            relationships:
              type: object
              properties:
                market:
                  required:
                  - data
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - markets
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                payment_gateway:
                  required:
                  - data
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - payment_gateways
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                store:
                  required:
                  - data
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - stores
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
    paymentMethodResponseList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/paymentMethodResponse/properties/data'
    paymentMethodResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: Unique identifier for the resource (hash).
              example: XAyRWNUzyN
            type:
              type: string
              description: The resource's type
              enum:
              - payment_methods
            links:
              type: object
              properties:
                self:
                  type: string
                  description: URL
            attributes:
              $ref: '#/components/schemas/paymentMethod/properties/data/properties/attributes'
            relationships:
              type: object
              properties:
                market:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - market
                        id:
                          type: string
                          description: The resource ID
                payment_gateway:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - payment_gateway
                        id:
                          type: string
                          description: The resource ID
                store:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - store
                        id:
                          type: string
                          description: The resource ID
                attachments:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - attachments
                        id:
                          type: string
                          description: The resource ID
                event_stores:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - event_stores
                        id:
                          type: string
                          description: The resource ID
    paymentMethod:
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - payment_methods
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The payment method's internal name.
                  example: Stripe Payment
                  nullable: true
                payment_source_type:
                  type: string
                  description: The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
                  example: stripe_payments
                  nullable: false
                  enum:
                  - adyen_payments
                  - axerve_payments
                  - braintree_payments
                  - checkout_com_payments
                  - external_payments
                  - klarna_payments
                  - paypal_payments
                  - satispay_payments
                  - stripe_payments
                  - wire_transfers
                currency_code:
                  type: string
                  description: The international 3-letter currency code as defined by the ISO 4217 standard.
                  example: EUR
                  nullable: true
                moto:
                  type: boolean
                  description: Send this attribute if you want to mark the payment as MOTO, must be supported by payment gateway.
                  example: false
                  nullable: true
                require_capture:
                  type: boolean
                  description: Send this attribute if you want to require the payment capture before fulfillment.
                  example: true
                  nullable: true
                auto_place:
                  type: boolean
                  description: Send this attribute if you want to automatically place the order upon authorization performed asynchronously.
                  example: true
                  nullable: true
                auto_capture:
                  type: boolean
                  description: Send this attribute if you want to automatically capture the payment upon authorization.
                  example: false
                  nullable: true
                price_amount_cents:
                  type: integer
                  description: The payment method's price, in cents.
                  example: 0
                  nullable: false
                price_amount_float:
                  type: number
                  description: The payment method's price, float.
                  example: 0.0
                  nullable: true
                formatted_price_amount:
                  type: string
                  description: The payment method's price, formatted.
                  example: €0,00
                  nullable: true
                auto_capture_max_amount_cents:
                  type: integer
                  description: Send this attribute if you want to limit automatic capture to orders for which the total amount is equal or less than the specified value, in cents.
                  example: 0
                  nullable: true
                auto_capture_max_amount_float:
                  type: number
                  description: The automatic capture max amount, float.
                  example: 0.0
                  nullable: true
                formatted_auto_capture_max_amount:
                  type: string
                  description: The automatic capture max amount, formatted.
                  example: €0,00
                  nullable: true
                disabled_at:
                  type: string
                  description: Time at which this resource was disabled.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: true
                created_at:
                  type: string
                  description: Time at which the resource was created.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                updated_at:
                  type: string
                  description: Time at which the resource was last updated.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                  nullable: true
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                  nullable: true
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
                  nullable: true
            relationships:
              type: object
              properties:
                market:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - markets
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                payment_gateway:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - payment_gateways
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                store:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - stores
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                attachments:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - attachments
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                event_stores:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - event_stores
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
    paymentMethodCreate:
      required:
      - data
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - payment_methods
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The payment method's internal name.
                  example: Stripe Payment
                payment_source_type:
                  type: string
                  description: The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
                  example: stripe_payments
                  enum:
                  - adyen_payments
                  - axerve_payments
                  - braintree_payments
                  - checkout_com_payments
                  - external_payments
                  - klarna_payments
                  - paypal_payments
                  - satispay_payments
                  - stripe_payments
                  - wire_transfers
                currency_code:
                  type: string
                  description: The international 3-letter currency code as defined by the ISO 4217 standard.
                  example: EUR
                moto:
                  type: boolean
                  description: Send this attribute if you want to mark the payment as MOTO, must be supported by payment gateway.
                  example: false
                require_capture:
                  type: boolean
                  description: Send this attribute if you want to require the payment capture before fulfillment.
                  example: true
                auto_place:
                  type: boolean
                  description: Send this attribute if you want to automatically place the order upon authorization performed asynchronously.
                  example: true
                auto_capture:
                  type: boolean
                  description: Send this attribute if you want to automatically capture the payment upon authorization.
                  example: false
                price_amount_cents:
                  type: integer
                  description: The payment method's price, in cents.
                  example: 0
                auto_capture_max_amount_cents:
                  type: integer
                  description: Send this attribute if you want to limit automatic capture to orders for which the total amount is equal or less than the specified value, in cents.
                  example: 0
                _disable:
                  type: boolean
                  description: Send this attribute if you want to mark this resource as disabled.
                  example: true
                _enable:
                  type: boolean
                  description: Send this attribute if you want to mark this resource as enabled.
                  example: true
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
              required:
              - payment_source_type
              - price_amount_cents
            relationships:
              type: object
              properties:
                market:
                  required:
                  - data
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - markets
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                payment_gateway:
                  required:
                  - data
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - payment_gateways
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                store:
                  required:
                  - data
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - stores
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
              required:
              - payment_gateway
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT