createPaypalExpressToken mutation

The createPaypalExpressToken mutation begins the authorization process for the following payment methods:

• PayPal Express Checkout
• PayPal Payflow Pro with Express Checkout
• PayPal Payflow Link with Express Checkout

The input includes the cart ID, the payment method code, and a set of URLs that PayPal uses to respond to the token request. If the request is successful, PayPal returns a token. The setPaymentMethodOnCart mutation uses this token later in the authorization process.

Syntax

1
2
3
4
5
6
7
mutation {
  createPaypalExpressToken(
    input: PaypalExpressTokenInput!
  ) {
    PaypalExpressTokenOutput
  }
}

Example usage

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
mutation {
  createPaypalExpressToken(
    input: {
      cart_id: "rMQdWEecBZr4SVWZwj2AF6y0dNCKQ8uH"
      code: "paypal_express"
      express_button: true
      urls: {
        return_url: "paypal/action/return.html"
        cancel_url: "paypal/action/cancel.html"
      }
    }
  ) {
    token
    paypal_urls {
      start
      edit
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
{
  "data": {
    "createPaypalExpressToken": {
      "token": "<PayPal_Token>",
      "paypal_urls": {
        "start": "https://www.sandbox.paypal.com/checkoutnow?token=<PayPal_Token>",
        "edit": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&useraction=continue&token=<PayPal_Token>"
      }
    }
  }
}

Input attributes

PaypalExpressTokenInput

The PaypalExpressTokenInput object defines the attributes required to receive a payment token from PayPal.

PaypalExpressUrlsInput

The PaypalExpressUrlsInput object contains a set of relative URLs that PayPal will use in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Express Checkout and Payments Standard payment methods.

Output attributes

The createPaypalExpressToken mutation previously returned a PaypalExpressToken object, which has been deprecated. The mutation now returns a PaypalExpressTokenOutput object. The contents of these objects are identical.

PaypalExpressTokenOutput

The PaypalExpressToken object contains a token returned by PayPal and a set of URLs that allow the buyer to authorize payment and adjust checkout details.

PaypalExpressUrlList

The PaypalExpressUrlList object defines a set of URLs that allow the buyer to authorize payment and adjust checkout details.

Errors