createPaymentOrder mutation

The createPaymentOrder mutation creates a payment order for later processing with Payment Services enabled.

The mutation can return details about the following payment methods supported in Payment Services:

• Apple Pay
• Google Pay
• PayPal Hosted Fields
• PayPal Smart Buttons

Each of these payment methods can have a different payment source, for example, PayPal Hosted Fields only works with credit cards. You need to run getPaymentConfig and setPaymentMethodOnCart endpoints before running the createPaymentOrder mutation.

Syntax

Copy
mutation { 
    createPaymentOrder(
        input: CreatePaymentOrderInput! 
    ) CreatePaymentOrderOutput    
}
Copied to your clipboard
mutation { 
    createPaymentOrder(
        input: CreatePaymentOrderInput! 
    ) CreatePaymentOrderOutput    
}

Example usage

The following example creates a payment order. The payment method was previously set to payment_services_paypal_hosted_fields.

Request:

Copy
mutation {
  createPaymentOrder(input: {
    cartId: "AJCY8dhIfuch9LcDHAxEkw7oG3DjGdKt"
    methodCode: "payment_services_paypal_hosted_fields"
    paymentSource: "cc"
    location: CHECKOUT
    vaultIntent: false
  }) {
    id
    mp_order_id
    status
    amount
    currency_code
  }
}
Copied to your clipboard
mutation {
  createPaymentOrder(input: {
    cartId: "AJCY8dhIfuch9LcDHAxEkw7oG3DjGdKt"
    methodCode: "payment_services_paypal_hosted_fields"
    paymentSource: "cc"
    location: CHECKOUT
    vaultIntent: false
  }) {
    id
    mp_order_id
    status
    amount
    currency_code
  }
}

Response:

Copy
{
  "data": {
    "createPaymentOrder": {
      "id": "9SA28234K9340625D",
      "mp_order_id": "mp-order-8b0488f9-46c5-4640-b577-c5f7d90cf224",
      "status": "CREATED",
      "amount": 50,
      "currency_code": "USD"
    }
  }
}
Copied to your clipboard
{
  "data": {
    "createPaymentOrder": {
      "id": "9SA28234K9340625D",
      "mp_order_id": "mp-order-8b0488f9-46c5-4640-b577-c5f7d90cf224",
      "status": "CREATED",
      "amount": 50,
      "currency_code": "USD"
    }
  }
}

Input attributes

The CreatePaymentOrderinput object contains the following input attributes:

PRODUCT_DETAIL, MINICART, CART, CHECKOUT, ADMIN methodCode | String! | The code for the selected payment method paymentSource | String! | The payment source for the payment method. The possible values are credit card (cc), PayPal (paypal), and Apple Pay (applepay) vaultIntent | Boolean | Indicates whether the payment information should be vaulted. This attribute is only applicable to the hosted_fields payment method. The default value is false

Output attributes

The CreatePaymentOrderOutput object contains the payment order details that are needed to fulfill a payment.

See PayPal currency codes documentation for more information.

Last updated 12/1/2023

Was this helpful?

Yes

No