Adobe Suite Carts/mine/payment Information API

openapi: 3.2.0
info:
  version: 2.4.6
  title: Commerce Customer REST endpoints - All inclusive…
  description:
    $ref: intro/redocly-intro.md
servers:
- url: https://example.com/rest/default
tags:
- name: carts/mine/payment-information
paths:
  /V1/carts/mine/payment-information:
    post:
      tags:
      - carts/mine/payment-information
      description: Set payment information and place order for a specified cart.
      operationId: PostV1CartsMinePaymentinformation
      responses:
        '200':
          description: 200 Success.
          content:
            application/json:
              schema:
                type: integer
                description: Order ID.
            application/xml:
              schema:
                type: integer
                description: Order ID.
        '401':
          description: 401 Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
        '500':
          description: Internal Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
      summary: carts/mine/payment-information
      requestBody:
        content:
          application/json:
            schema:
              required:
              - paymentMethod
              properties:
                paymentMethod:
                  $ref: '#/components/schemas/quote-data-payment-interface'
                billingAddress:
                  $ref: '#/components/schemas/quote-data-address-interface'
              type: object
              xml:
                name: request
          application/xml:
            schema:
              required:
              - paymentMethod
              properties:
                paymentMethod:
                  $ref: '#/components/schemas/quote-data-payment-interface'
                billingAddress:
                  $ref: '#/components/schemas/quote-data-address-interface'
              type: object
              xml:
                name: request
    get:
      tags:
      - carts/mine/payment-information
      description: Get payment information
      operationId: GetV1CartsMinePaymentinformation
      responses:
        '200':
          description: 200 Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkout-data-payment-details-interface'
            application/xml:
              schema:
                $ref: '#/components/schemas/checkout-data-payment-details-interface'
        '401':
          description: 401 Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
      summary: carts/mine/payment-information
components:
  schemas:
    checkout-data-payment-details-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface
    tax-data-grand-total-details-interface:
      type: object
      description: Interface GrandTotalDetailsInterface
      properties:
        amount:
          type: number
          description: Tax amount value
        rates:
          type: array
          description: Tax rates info
          items:
            $ref: '#/components/schemas/tax-data-grand-total-rates-interface'
        group_id:
          type: integer
          description: Group identifier
      required:
      - amount
      - rates
      - group_id
    quote-data-totals-interface:
      type: object
      description: Interface TotalsInterface
      properties:
        grand_total:
          type: number
          description: Grand total in quote currency
        base_grand_total:
          type: number
          description: Grand total in base currency
        subtotal:
          type: number
          description: Subtotal in quote currency
        base_subtotal:
          type: number
          description: Subtotal in base currency
        discount_amount:
          type: number
          description: Discount amount in quote currency
        base_discount_amount:
          type: number
          description: Discount amount in base currency
        subtotal_with_discount:
          type: number
          description: Subtotal in quote currency with applied discount
        base_subtotal_with_discount:
          type: number
          description: Subtotal in base currency with applied discount
        shipping_amount:
          type: number
          description: Shipping amount in quote currency
        base_shipping_amount:
          type: number
          description: Shipping amount in base currency
        shipping_discount_amount:
          type: number
          description: Shipping discount amount in quote currency
        base_shipping_discount_amount:
          type: number
          description: Shipping discount amount in base currency
        tax_amount:
          type: number
          description: Tax amount in quote currency
        base_tax_amount:
          type: number
          description: Tax amount in base currency
        weee_tax_applied_amount:
          type: number
          description: Item weee tax applied amount in quote currency.
        shipping_tax_amount:
          type: number
          description: Shipping tax amount in quote currency
        base_shipping_tax_amount:
          type: number
          description: Shipping tax amount in base currency
        subtotal_incl_tax:
          type: number
          description: Subtotal including tax in quote currency
        base_subtotal_incl_tax:
          type: number
          description: Subtotal including tax in base currency
        shipping_incl_tax:
          type: number
          description: Shipping including tax in quote currency
        base_shipping_incl_tax:
          type: number
          description: Shipping including tax in base currency
        base_currency_code:
          type: string
          description: Base currency code
        quote_currency_code:
          type: string
          description: Quote currency code
        coupon_code:
          type: string
          description: Applied coupon code
        items_qty:
          type: integer
          description: Items qty
        items:
          type: array
          description: Totals by items
          items:
            $ref: '#/components/schemas/quote-data-totals-item-interface'
        total_segments:
          type: array
          description: Dynamically calculated totals
          items:
            $ref: '#/components/schemas/quote-data-total-segment-interface'
        extension_attributes:
          $ref: '#/components/schemas/quote-data-totals-extension-interface'
      required:
      - weee_tax_applied_amount
      - total_segments
    quote-data-address-interface:
      type: object
      description: Interface AddressInterface
      properties:
        id:
          type: integer
          description: Id
        region:
          type: string
          description: Region name
        region_id:
          type: integer
          description: Region id
        region_code:
          type: string
          description: Region code
        country_id:
          type: string
          description: Country id
        street:
          type: array
          description: Street
          items:
            type: string
        company:
          type: string
          description: Company
        telephone:
          type: string
          description: Telephone number
        fax:
          type: string
          description: Fax number
        postcode:
          type: string
          description: Postcode
        city:
          type: string
          description: City name
        firstname:
          type: string
          description: First name
        lastname:
          type: string
          description: Last name
        middlename:
          type: string
          description: Middle name
        prefix:
          type: string
          description: Prefix
        suffix:
          type: string
          description: Suffix
        vat_id:
          type: string
          description: Vat id
        customer_id:
          type: integer
          description: Customer id
        email:
          type: string
          description: Billing/shipping email
        same_as_billing:
          type: integer
          description: Same as billing flag
        customer_address_id:
          type: integer
          description: Customer address id
        save_in_address_book:
          type: integer
          description: Save in address book flag
        extension_attributes:
          $ref: '#/components/schemas/quote-data-address-extension-interface'
        custom_attributes:
          type: array
          description: Custom attributes values.
          items:
            $ref: '#/components/schemas/framework-attribute-interface'
      required:
      - region
      - region_id
      - region_code
      - country_id
      - street
      - telephone
      - postcode
      - city
      - firstname
      - lastname
      - email
    quote-data-totals-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface
      properties:
        coupon_label:
          type: string
        negotiable_quote_totals:
          $ref: '#/components/schemas/negotiable-quote-data-negotiable-quote-totals-interface'
        base_customer_balance_amount:
          type: number
        customer_balance_amount:
          type: number
        reward_points_balance:
          type: number
        reward_currency_amount:
          type: number
        base_reward_currency_amount:
          type: number
    negotiable-quote-data-negotiable-quote-item-totals-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface
    negotiable-quote-data-negotiable-quote-item-totals-interface:
      type: object
      description: Extension attribute for quote item totals model.
      properties:
        cost:
          type: number
          description: Cost for quote item.
        catalog_price:
          type: number
          description: Catalog price for quote item.
        base_catalog_price:
          type: number
          description: Catalog price for quote item in base currency.
        catalog_price_incl_tax:
          type: number
          description: Catalog price with included tax for quote item.
        base_catalog_price_incl_tax:
          type: number
          description: Catalog price with included tax for quote item in base currency.
        cart_price:
          type: number
          description: Cart price for quote item.
        base_cart_price:
          type: number
          description: Cart price for quote item in base currency.
        cart_tax:
          type: number
          description: Tax from catalog price for quote item.
        base_cart_tax:
          type: number
          description: Tax from catalog price for quote item in base currency.
        cart_price_incl_tax:
          type: number
          description: Cart price with included tax for quote item.
        base_cart_price_incl_tax:
          type: number
          description: Cart price with included tax for quote item in base currency.
        extension_attributes:
          $ref: '#/components/schemas/negotiable-quote-data-negotiable-quote-item-totals-extension-interface'
      required:
      - cost
      - catalog_price
      - base_catalog_price
      - catalog_price_incl_tax
      - base_catalog_price_incl_tax
      - cart_price
      - base_cart_price
      - cart_tax
      - base_cart_tax
      - cart_price_incl_tax
      - base_cart_price_incl_tax
    quote-data-total-segment-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface
      properties:
        tax_grandtotal_details:
          type: array
          items:
            $ref: '#/components/schemas/tax-data-grand-total-details-interface'
        gift_cards:
          type: string
        gw_order_id:
          type: string
        gw_item_ids:
          type: array
          items:
            type: string
        gw_allow_gift_receipt:
          type: string
        gw_add_card:
          type: string
        gw_price:
          type: string
        gw_base_price:
          type: string
        gw_items_price:
          type: string
        gw_items_base_price:
          type: string
        gw_card_price:
          type: string
        gw_card_base_price:
          type: string
        gw_base_tax_amount:
          type: string
        gw_tax_amount:
          type: string
        gw_items_base_tax_amount:
          type: string
        gw_items_tax_amount:
          type: string
        gw_card_base_tax_amount:
          type: string
        gw_card_tax_amount:
          type: string
        gw_price_incl_tax:
          type: string
        gw_base_price_incl_tax:
          type: string
        gw_card_price_incl_tax:
          type: string
        gw_card_base_price_incl_tax:
          type: string
        gw_items_price_incl_tax:
          type: string
        gw_items_base_price_incl_tax:
          type: string
    quote-data-totals-item-interface:
      type: object
      description: Interface TotalsItemInterface
      properties:
        item_id:
          type: integer
          description: Item id
        price:
          type: number
          description: Item price in quote currency.
        base_price:
          type: number
          description: Item price in base currency.
        qty:
          type: number
          description: Item quantity.
        row_total:
          type: number
          description: Row total in quote currency.
        base_row_total:
          type: number
          description: Row total in base currency.
        row_total_with_discount:
          type: number
          description: Row total with discount in quote currency. Otherwise, null.
        tax_amount:
          type: number
          description: Tax amount in quote currency. Otherwise, null.
        base_tax_amount:
          type: number
          description: Tax amount in base currency. Otherwise, null.
        tax_percent:
          type: number
          description: Tax percent. Otherwise, null.
        discount_amount:
          type: number
          description: Discount amount in quote currency. Otherwise, null.
        base_discount_amount:
          type: number
          description: Discount amount in base currency. Otherwise, null.
        discount_percent:
          type: number
          description: Discount percent. Otherwise, null.
        price_incl_tax:
          type: number
          description: Price including tax in quote currency. Otherwise, null.
        base_price_incl_tax:
          type: number
          description: Price including tax in base currency. Otherwise, null.
        row_total_incl_tax:
          type: number
          description: Row total including tax in quote currency. Otherwise, null.
        base_row_total_incl_tax:
          type: number
          description: Row total including tax in base currency. Otherwise, null.
        options:
          type: string
          description: Item price in quote currency.
        weee_tax_applied_amount:
          type: number
          description: Item weee tax applied amount in quote currency.
        weee_tax_applied:
          type: string
          description: Item weee tax applied in quote currency.
        extension_attributes:
          $ref: '#/components/schemas/quote-data-totals-item-extension-interface'
        name:
          type: string
          description: Product name. Otherwise, null.
      required:
      - item_id
      - price
      - base_price
      - qty
      - row_total
      - base_row_total
      - options
      - weee_tax_applied_amount
      - weee_tax_applied
    quote-data-totals-item-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface
      properties:
        negotiable_quote_item_totals:
          $ref: '#/components/schemas/negotiable-quote-data-negotiable-quote-item-totals-interface'
    tax-data-grand-total-rates-interface:
      type: object
      description: Interface GrandTotalRatesInterface
      properties:
        percent:
          type: string
          description: Tax percentage value
        title:
          type: string
          description: Rate title
      required:
      - percent
      - title
    error-parameters-item:
      type: object
      description: Error parameters item
      properties:
        resources:
          type: string
          description: ACL resource
        fieldName:
          type: string
          description: Missing or invalid field name
        fieldValue:
          type: string
          description: Incorrect field value
    negotiable-quote-data-negotiable-quote-totals-interface:
      type: object
      description: Extension attribute for quote totals model.
      properties:
        items_count:
          type: integer
          description: The number of different items or products in the cart.
        quote_status:
          type: string
          description: Negotiable quote status.
        created_at:
          type: string
          description: The cart creation date and time.
        updated_at:
          type: string
          description: The cart last update date and time.
        customer_group:
          type: integer
          description: Customer group id.
        base_to_quote_rate:
          type: number
          description: Base currency to quote currency rate.
        cost_total:
          type: number
          description: Total cost for quote.
        base_cost_total:
          type: number
          description: Total cost for quote in base currency.
        original_total:
          type: number
          description: Original quote total.
        base_original_total:
          type: number
          description: Original quote total in base currency.
        original_tax:
          type: number
          description: Original tax amount for quote.
        base_original_tax:
          type: number
          description: Original tax amount for quote in base currency.
        original_price_incl_tax:
          type: number
          description: Original price with included tax for quote.
        base_original_price_incl_tax:
          type: number
          description: Original price with included tax for quote in base currency.
        negotiated_price_type:
          type: integer
          description: Negotiable quote type.
        negotiated_price_value:
          type: number
          description: Negotiable price value for quote.
      required:
      - items_count
      - quote_status
      - created_at
      - updated_at
      - customer_group
      - base_to_quote_rate
      - cost_total
      - base_cost_total
      - original_total
      - base_original_total
      - original_tax
      - base_original_tax
      - original_price_incl_tax
      - base_original_price_incl_tax
      - negotiated_price_type
      - negotiated_price_value
    checkout-data-payment-details-interface:
      type: object
      description: Interface PaymentDetailsInterface
      properties:
        payment_methods:
          type: array
          items:
            $ref: '#/components/schemas/quote-data-payment-method-interface'
        totals:
          $ref: '#/components/schemas/quote-data-totals-interface'
        extension_attributes:
          $ref: '#/components/schemas/checkout-data-payment-details-extension-interface'
      required:
      - payment_methods
      - totals
    quote-data-payment-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
      properties:
        agreement_ids:
          type: array
          items:
            type: string
    quote-data-payment-interface:
      type: object
      description: Interface PaymentInterface
      properties:
        po_number:
          type: string
          description: Purchase order number
        method:
          type: string
          description: Payment method code
        additional_data:
          type: array
          description: Payment additional details
          items:
            type: string
        extension_attributes:
          $ref: '#/components/schemas/quote-data-payment-extension-interface'
      required:
      - method
    quote-data-total-segment-interface:
      type: object
      description: Interface TotalsInterface
      properties:
        code:
          type: string
          description: Code
        title:
          type: string
          description: Total title
        value:
          type: number
          description: Total value
        area:
          type: string
          description: Display area code.
        extension_attributes:
          $ref: '#/components/schemas/quote-data-total-segment-extension-interface'
      required:
      - code
      - value
    framework-attribute-interface:
      type: object
      description: Interface for custom attribute value.
      properties:
        attribute_code:
          type: string
          description: Attribute code
        value:
          type: string
          description: Attribute value
      required:
      - attribute_code
      - value
    error-errors:
      type: array
      description: Errors list
      items:
        $ref: '#/components/schemas/error-errors-item'
    sales-rule-data-rule-discount-interface:
      type: object
      description: Rule discount Interface
      properties:
        discount_data:
          $ref: '#/components/schemas/sales-rule-data-discount-data-interface'
        rule_label:
          type: string
          description: Rule Label
        rule_id:
          type: integer
          description: Rule ID
      required:
      - discount_data
      - rule_label
      - rule_id
    sales-rule-data-discount-data-interface:
      type: object
      description: Discount Data Interface
      properties:
        amount:
          type: number
          description: Amount
        base_amount:
          type: number
          description: Base Amount
        original_amount:
          type: number
          description: Original Amount
        base_original_amount:
          type: number
          description: Base Original Amount
      required:
      - amount
      - base_amount
      - original_amount
      - base_original_amount
    quote-data-address-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
      properties:
        discounts:
          type: array
          items:
            $ref: '#/components/schemas/sales-rule-data-rule-discount-interface'
        gift_registry_id:
          type: integer
        pickup_location_code:
          type: string
        bolt_id:
          type: string
    error-errors-item:
      type: object
      description: Error details
      properties:
        message:
          type: string
          description: Error message
        parameters:
          $ref: '#/components/schemas/error-parameters'
    error-parameters:
      type: array
      description: Error parameters list
      items:
        $ref: '#/components/schemas/error-parameters-item'
    error-response:
      type: object
      properties:
        message:
          type: string
          description: Error message
        errors:
          $ref: '#/components/schemas/error-errors'
        code:
          type: integer
          description: Error code
        parameters:
          $ref: '#/components/schemas/error-parameters'
        trace:
          type: string
          description: Stack trace
      required:
      - message
    quote-data-payment-method-interface:
      type: object
      description: Interface PaymentMethodInterface
      properties:
        code:
          type: string
          description: Payment method code
        title:
          type: string
          description: Payment method title
      required:
      - code
      - title
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: header
x-tagGroups:
- name: applepay
  tags:
  - applepay/auth
- name: carts
  tags:
  - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
  - carts/guest-carts/{cartId}/giftCards
  - carts/guest-carts/{cartId}/giftCards/{giftCardCode}
  - carts/mine
  - carts/mine/balance/apply
  - carts/mine/checkGiftCard/{giftCardCode}
  - carts/mine/collect-totals
  - carts/mine/payment-information
  - carts/mine/po-payment-information
  - carts/mine/set-payment-information
- name: customers
  tags:
  - customers
  - customers/isEmailAvailable
  - customers/me/activate
  - customers/me/password
  - customers/password
  - customers/resetPassword
  - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
- name: directory
  tags:
  - directory/countries
  - directory/countries/{countryId}
  - directory/currency
- name: giftregistry
  tags:
  - giftregistry/mine/estimate-shipping-methods
- name: guest carts
  tags:
  - guest-carts
  - guest-carts/{cartId}
  - guest-carts/{cartId}/billing-address
  - guest-carts/{cartId}/collect-totals
  - guest-carts/{cartId}/coupons
  - guest-carts/{cartId}/coupons/{couponCode}
  - guest-carts/{cartId}/estimate-shipping-methods
  - guest-carts/{cartId}/gift-message
  - guest-carts/{cartId}/gift-message/{itemId}
  - guest-carts/{cartId}/items
  - guest-carts/{cartId}/items/{itemId}
  - guest-carts/{cartId}/order
  - guest-carts/{cartId}/payment-information
  - guest-carts/{cartId}/payment-methods
  - guest-carts/{cartId}/selected-payment-method
  - guest-carts/{cartId}/set-payment-information
  - guest-carts/{cartId}/shipping-information
  - guest-carts/{cartId}/shipping-methods
  - guest-carts/{cartId}/totals
  - guest-carts/{cartId}/totals-information
- name: guest giftregistry
  tags:
  - guest-giftregistry/{cartId}/estimate-shipping-methods
- name: integration
  tags:
  - integration/admin/token
  - integration/customer/revoke-customer-token
  - integration/customer/token
- name: inventory
  tags:
  - inventory/in-store-pickup/pickup-locations/
- name: negotiable carts
  tags:
  - negotiable-carts/{cartId}/billing-address
  - negotiable-carts/{cartId}/coupons
  - negotiable-carts/{cartId}/coupons/{couponCode}
  - negotiable-carts/{cartId}/estimate-shipping-methods
  - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
  - negotiable-carts/{cartId}/giftCards
  - negotiable-carts/{cartId}/giftCards/{giftCardCode}
  - negotiable-carts/{cartId}/payment-information
  - negotiable-carts/{cartId}/set-payment-information
  - negotiable-carts/{cartId}/shipping-information
  - negotiable-carts/{cartId}/totals
- name: products render info
  tags:
  - products-render-info
- name: purchase order carts
  tags:
  - purchase-order-carts/{cartId}/payment-information
  - purchase-order-carts/{cartId}/set-payment-information
- name: quick checkout
  tags:
  - quick-checkout/account-details
  - quick-checkout/has-account
  - quick-checkout/storefront/has-account
- name: requisition_lists
  tags:
  - requisition_lists
- name: reward
  tags:
  - reward/mine/use-reward
- name: search
  tags:
  - search
- name: tfa
  tags:
  - tfa/provider/authy/activate
  - tfa/provider/authy/authenticate
  - tfa/provider/authy/authenticate-onetouch
  - tfa/provider/authy/configure
  - tfa/provider/authy/send-token/{via}
  - tfa/provider/duo_security/activate
  - tfa/provider/duo_security/authenticate
  - tfa/provider/duo_security/configure
  - tfa/provider/duo_security/get-authentication-data
  - tfa/provider/google/activate
  - tfa/provider/google/authenticate
  - tfa/provider/google/configure
  - tfa/provider/u2fkey/activate
  - tfa/provider/u2fkey/authentication-challenge
  - tfa/provider/u2fkey/configure
  - tfa/provider/u2fkey/verify
  - tfa/tfat-providers-to-activate
  - tfa/tfat-user-providers