Maginium
Admin Api
Admin Api
  • About
  • API reference
    • CustomerGroups
      • Permissions
      • Default
      • Search
    • Customers
      • Confirm
      • BillingAddress
      • ShippingAddress
      • Carts
      • Me
        • Activate
        • Password
        • BillingAddress
        • ShippingAddress
      • Search
      • Activate
      • Password
        • ResetLinkToken
      • ResetPassword
      • Validate
      • IsEmailAvailable
      • Addresses
      • Permissions
        • Readonly
    • CmsPage
      • Search
    • CmsBlock
      • Search
    • Products
      • Media
        • Types
      • Options
        • Types
      • Links
        • Types
        • Attributes
      • Websites
      • Downloadable links
        • Samples
      • Attributes
        • Options
        • Types
      • Attribute sets
        • Attributes
        • Groups
          • List
        • Sets
          • List
      • Tier prices
      • Types
      • Tier prices information
      • Tier prices delete
      • Base prices information
      • Base prices
      • Cost information
      • Cost
      • Cost delete
      • Special price information
      • Special price
      • Special price delete
      • StockItems
      • Group prices
        • Tiers
          • Price
    • Categories
      • Attributes
        • Options
      • Products
      • Move
      • List
    • StockItems
      • LowStock
        • /
    • Carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods by address id
      • Estimate shipping methods
      • Payment methods
      • Totals
      • Shipping information
      • Totals information
      • Mine
        • Items
        • Selected payment method
        • Billing address
        • Coupons
        • Payment information
        • Gift message
        • Order
        • Shipping methods
        • Estimate shipping methods by address id
        • Estimate shipping methods
        • Payment methods
        • Totals
        • Collect totals
        • Shipping information
        • Totals information
        • Set payment information
      • Licence
        • List
      • /
      • Search
    • Guest carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Payment information
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods
      • Payment methods
      • Collect totals
      • Totals
      • Shipping information
      • Totals information
      • Set payment information
    • Orders
      • Comments
      • Statuses
      • Cancel
      • Emails
      • Hold
      • Unhold
      • Items
      • Create
    • Invoices
      • Comments
      • Emails
      • Void
      • Capture
      • /
    • Creditmemo
      • Comments
      • Emails
      • Refund
    • Shipment
      • Comments
      • Emails
      • Label
      • Track
      • /
    • Transactions
    • TaxRates
      • Search
    • TaxRules
      • Search
    • TaxClasses
      • Search
    • SalesRules
      • Search
    • Coupons
      • Search
      • Generate
      • DeleteByIds
      • DeleteByCodes
    • Bulk
      • Detailed status
      • Status
      • Operation status
    • Modules
    • Search
    • Addresses
    • Products render info
    • StockStatuses
    • Creditmemos
    • Shipments
    • Amazon shipping address
    • Amazon billing address
    • Store
      • StoreViews
      • StoreGroups
      • Websites
      • StoreConfigs
    • Adobestock
      • Asset
        • Search
        • List
      • Search
    • Directory
      • Countries
      • Currency
    • Eav
      • Attribute sets
        • List
    • AttributeMetadata
      • Customer
        • Attribute
        • Form
        • Custom
      • CustomerAddress
        • Attribute
        • Form
        • Custom
    • Bundle products
      • Links
      • Options
        • Children
        • All
        • Types
        • Add
      • Children
    • Order
      • Refund
      • Ship
      • Invoice
      • Notify orders are ready for pickup
    • Configurable products
      • Children
      • Options
        • All
      • Child
      • Variation
    • Inventory
      • Sources
      • Stocks
      • Stock source links
      • Source items
      • Low quantity notification
      • Get sources assigned to stock ordered by priority
      • Stock source links delete
      • Source items delete
      • Bulk product source assign
      • Bulk product source unassign
      • Bulk product source transfer
      • Bulk partial source transfer
      • Get distance provider code
      • Get distance
      • Get latlng from address
      • Get latslngs from address
      • Export stock salable qty
      • Dump stock index data
      • Get product salable quantity
      • Is product salable
      • Are products salable
      • Is product salable for requested qty
      • Stock resolver
      • Source selection algorithm list
      • Source selection algorithm result
      • Low quantity notifications delete
      • Are product salable for requested qty
        • /
      • In store pickup
        • Pickup locations
          • /
    • Invoice
      • Refund
    • Analytics
      • Link
    • Amazon
      • Order ref
    • Applepay
      • Auth
    • Address
      • Cleanse
    • Guest address
      • Cleanse
    • Vertex address validation
      • Vertex address
    • Integration
      • Admin
        • Token
      • Customer
        • Token
Powered by GitBook
On this page
  1. API reference
  2. Carts
  3. Mine

Payment information

PreviousCouponsNextGift message
  • GETcheckout Payment Information Management V1Get Payment Information Get
  • POSTcheckout Payment Information Management V1Save Payment Information And Place Order Post

checkout Payment Information Management V1Get Payment Information Get

get

Get payment information

Responses
200
OK
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/carts/mine/payment-information HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "payment_methods": [
    {
      "code": "deserunt do in laborum",
      "title": "aute sunt enim officia"
    },
    {
      "code": "amet",
      "title": "dolore deserunt"
    }
  ],
  "totals": {
    "weee_tax_applied_amount": 99234893.77747533,
    "total_segments": [
      {
        "code": "minim Lorem",
        "value": -2248756.4386974424,
        "title": "qui et laborum ad",
        "area": "do qui",
        "extension_attributes": {
          "tax_grandtotal_details": [
            {
              "amount": 55701388.14952478,
              "rates": [
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                },
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                }
              ],
              "group_id": 51670142
            },
            {
              "amount": 74100334.86008167,
              "rates": [
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                },
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                }
              ],
              "group_id": -18160999
            }
          ],
          "vertex_tax_calculation_messages": [
            "ullamco commodo Excepteur ut",
            "of"
          ]
        }
      },
      {
        "code": "",
        "value": 69839449.85392183,
        "title": "elit sed sint",
        "area": "s",
        "extension_attributes": {
          "tax_grandtotal_details": [
            {
              "amount": 21702113.62615238,
              "rates": [
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                },
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                }
              ],
              "group_id": -61368748
            },
            {
              "amount": -59918469.44821222,
              "rates": [
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                },
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                }
              ],
              "group_id": -46088270
            }
          ],
          "vertex_tax_calculation_messages": [
            "Ut velit incididunt",
            "in"
          ]
        }
      }
    ],
    "grand_total": 15505714.253978372,
    "base_grand_total": -32202033.86666985,
    "subtotal": -62174169.21826948,
    "base_subtotal": 90091551.17900565,
    "discount_amount": 38876007.101442546,
    "base_discount_amount": -23782731.463969767,
    "subtotal_with_discount": -70100678.31908469,
    "base_subtotal_with_discount": 99461275.79835412,
    "shipping_amount": -1656861.9189197123,
    "base_shipping_amount": -48079502.053705744,
    "shipping_discount_amount": 77030151.74572831,
    "base_shipping_discount_amount": -84349051.94884354,
    "tax_amount": 25993610.491242602,
    "base_tax_amount": -55273606.648034826,
    "shipping_tax_amount": 49154556.35198441,
    "base_shipping_tax_amount": -17189126.493037626,
    "subtotal_incl_tax": -96509997.0768342,
    "base_subtotal_incl_tax": 66206805.47262728,
    "shipping_incl_tax": 79587837.60411054,
    "base_shipping_incl_tax": 36711484.99221614,
    "base_currency_code": "sint",
    "quote_currency_code": "laborum do adipisici",
    "coupon_code": "pariatur",
    "items_qty": -74407494,
    "items": [
      {
        "item_id": -3732193,
        "price": -46555134.29438702,
        "base_price": -8364970.515636653,
        "qty": -14240659.234266266,
        "row_total": 93278231.80123937,
        "base_row_total": 95451606.42505768,
        "options": "est pariatur velit id",
        "weee_tax_applied_amount": -60044476.08419827,
        "weee_tax_applied": "Ut nostrud",
        "row_total_with_discount": 44790745.71187681,
        "tax_amount": 4314403.612548381,
        "base_tax_amount": -86669566.39424846,
        "tax_percent": -28230760.213681087,
        "discount_amount": 15140263.819226041,
        "base_discount_amount": 52536192.83385831,
        "discount_percent": -61403668.218807675,
        "price_incl_tax": -52184917.482550874,
        "base_price_incl_tax": -15870369.57897681,
        "row_total_incl_tax": 98301049.07072315,
        "base_row_total_incl_tax": 92230168.46224627,
        "extension_attributes": {},
        "name": "mollit dolor"
      },
      {
        "item_id": -26213904,
        "price": -83319976.07598191,
        "base_price": -44113154.45220789,
        "qty": -621163.4945136905,
        "row_total": 64465023.54365027,
        "base_row_total": 26939867.638823718,
        "options": "amet fugiat ut voluptate",
        "weee_tax_applied_amount": -15632062.933786184,
        "weee_tax_applied": "au",
        "row_total_with_discount": -11057376.114937335,
        "tax_amount": -33941141.37015065,
        "base_tax_amount": 60012982.00764117,
        "tax_percent": -53712873.10613142,
        "discount_amount": 77383025.31472653,
        "base_discount_amount": -27652757.97586359,
        "discount_percent": -43819850.73850725,
        "price_incl_tax": 14312190.468128443,
        "base_price_incl_tax": 11595302.27741991,
        "row_total_incl_tax": -57770212.64065407,
        "base_row_total_incl_tax": 86204180.1387912,
        "extension_attributes": {},
        "name": "esse dolore Excepteur"
      }
    ],
    "extension_attributes": {
      "coupon_label": "Ut amet pariatur sed ad"
    }
  },
  "extension_attributes": {}
}

checkout Payment Information Management V1Save Payment Information And Place Order Post

post

Set payment information and place order for a specified cart.

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"paymentMethod":{"method":"<string>","po_number":"<string>","additional_data":["<string>","<string>"],"extension_attributes":{"agreement_ids":["<string>","<string>"]}},"billingAddress":{"region":"et labori","region_id":74972906,"region_code":"sint aliqua","country_id":"in velit Duis","street":["do eu commodo","pariatur elit exercitation"],"telephone":"fugiat aute aliqua quis","postcode":"eu","city":"et enim ad voluptate","firstname":"ex aute ","lastname":"elit mollit","email":"ullamco anim","id":3585841,"company":"Excepteur consectetur ad fugiat laboris","fax":"exercitation consectetur","middlename":"est","prefix":"do culpa sunt","suffix":"laborum officia sit","vat_id":"minim aliqua ullam","customer_id":40886534,"same_as_billing":-99467414,"customer_address_id":-67878945,"save_in_address_book":29086027,"extension_attributes":{"pickup_location_code":"ex nulla ipsum","discounts":[{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"quis","rule_id":28068735},{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"sint occaecat","rule_id":-37035350}]},"custom_attributes":[{"attribute_code":"","value":"id enim sed"},{"attribute_code":"Duis adipisicing","value":"sint Excepteur"}]}}
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
POST /V1/carts/mine/payment-information HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 1284

{
  "paymentMethod": {
    "method": "<string>",
    "po_number": "<string>",
    "additional_data": [
      "<string>",
      "<string>"
    ],
    "extension_attributes": {
      "agreement_ids": [
        "<string>",
        "<string>"
      ]
    }
  },
  "billingAddress": {
    "region": "et labori",
    "region_id": 74972906,
    "region_code": "sint aliqua",
    "country_id": "in velit Duis",
    "street": [
      "do eu commodo",
      "pariatur elit exercitation"
    ],
    "telephone": "fugiat aute aliqua quis",
    "postcode": "eu",
    "city": "et enim ad voluptate",
    "firstname": "ex aute ",
    "lastname": "elit mollit",
    "email": "ullamco anim",
    "id": 3585841,
    "company": "Excepteur consectetur ad fugiat laboris",
    "fax": "exercitation consectetur",
    "middlename": "est",
    "prefix": "do culpa sunt",
    "suffix": "laborum officia sit",
    "vat_id": "minim aliqua ullam",
    "customer_id": 40886534,
    "same_as_billing": -99467414,
    "customer_address_id": -67878945,
    "save_in_address_book": 29086027,
    "extension_attributes": {
      "pickup_location_code": "ex nulla ipsum",
      "discounts": [
        {
          "discount_data": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "rule_label": "quis",
          "rule_id": 28068735
        },
        {
          "discount_data": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "rule_label": "sint occaecat",
          "rule_id": -37035350
        }
      ]
    },
    "custom_attributes": [
      {
        "attribute_code": "",
        "value": "id enim sed"
      },
      {
        "attribute_code": "Duis adipisicing",
        "value": "sint Excepteur"
      }
    ]
  }
}
22109788