MageSmith
POSTCheckout · Magento 2.4.9 Self (customer or admin)

POST /V1/carts/mine/set-payment-information

POST /V1/carts/mine/set-payment-information is a Magento 2 REST endpoint in the Checkout module. Set payment information for a specified cart. Requires a customer or admin Bearer token (whichever owns the resource).

Last verified: against Magento 2.4.9.

Returns

int

Order ID.

Service contract

Magento\Checkout\Api\PaymentInformationManagementInterface::savePaymentInformation

Authorization

Self — a customer Bearer token (when the caller owns the resource) or an admin token both work.

Body parameters

cartId int Required
paymentMethod Magento\Quote\Api\Data\PaymentInterface Required
billingAddress Magento\Quote\Api\Data\AddressInterface default: null

Example request

Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.

Headers

Accept
application/json
Content-Type
application/json
Authorization
Bearer <ACCESS_TOKEN> customer or admin token (whoever owns the resource)

Path

/V1/carts/mine/set-payment-information

Body

{
  "billingAddress": {
    "city": "",
    "company": "",
    "country_id": "",
    "custom_attributes": [
      {
        "attribute_code": "",
        "value": ""
      }
    ],
    "customer_address_id": 0,
    "customer_id": 0,
    "email": "",
    "extension_attributes": {},
    "fax": "",
    "firstname": "",
    "id": 0,
    "lastname": "",
    "middlename": "",
    "postcode": "",
    "prefix": "",
    "region": "",
    "region_code": "",
    "region_id": 0,
    "same_as_billing": 0,
    "save_in_address_book": 0,
    "street": [
      {}
    ],
    "suffix": "",
    "telephone": "",
    "vat_id": ""
  },
  "cartId": 0,
  "paymentMethod": {
    "additional_data": [
      {}
    ],
    "extension_attributes": {},
    "method": "",
    "po_number": ""
  }
}

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.