Merge pull request #7714 from magento/kh_payflow-vault

GraphQL: Add support for Vault on Payflow Pro

Author: keharper

src/_data/toc/graphql.yml

@@ -318,6 +318,10 @@ pages:
         - label: PayPal Payflow Pro
           url: /graphql/payment-methods/payflow-pro.html
 
+        - label: PayPal Payflow Pro Vault
+          url: /graphql/payment-methods/payflow-pro-vault.html
+          exclude_versions: ["2.3"]
+
         - label: PayPal Payments Advanced
           url: /graphql/payment-methods/payments-advanced.html
 

src/common/images/graphql/paypal-payflow-pro-vault.svg

@@ -20,7 +20,7 @@ The following diagram shows the workflow for placing an order when Braintree Vau
 
 1. The client renders the token information, and the customer selects a payment method.
 
-   When the customer clicks **Place Order**, the PWA uses the [`setPaymentMethodOnCart`]({{page.baseurl}}/graphql/mutations/set-payment-method.html) mutation to set the payment method to `braintree_cc_vault`. The vaulted public hash is passed with other optional properties in the [`braintree_cc_vault`](#braintree_cc_vault-object).
+   When the customer selects a stored payment method, the PWA uses the [`setPaymentMethodOnCart`]({{page.baseurl}}/graphql/mutations/set-payment-method.html) mutation to set the payment method to `braintree_cc_vault`. The vaulted public hash is passed with other optional properties in the [`braintree_cc_vault`](#braintree_cc_vault-object).
 
 1. Magento returns a `Cart` object.
 

src/guides/v2.3/graphql/payment-methods/braintree-vault.md

@@ -20,6 +20,7 @@ Supported online payment methods include:
 -  [PayPal Express Checkout]({{page.baseurl}}/graphql/payment-methods/paypal-express-checkout.html)
 -  [PayPal Payflow Link]({{page.baseurl}}/graphql/payment-methods/payflow-link.html)
 -  [PayPal Payflow Pro]({{page.baseurl}}/graphql/payment-methods/payflow-pro.html)
+-  [PayPal Payflow Pro Vault]({{page.baseurl}}/graphql/payment-methods/payflow-pro-vault.html)
 -  [PayPal Payments Advanced]({{page.baseurl}}/graphql/payment-methods/payments-advanced.html)
 -  [PayPal Website Payments Pro Hosted Solution]({{page.baseurl}}/graphql/payment-methods/hosted-pro.html)
 -  [Express Checkout for other PayPal solutions]({{page.baseurl}}/graphql/payment-methods/payflow-express.html)

src/guides/v2.4/graphql/mutations/set-payment-method.md

@@ -0,0 +1,98 @@
+---
+group: graphql
+title: PayPal Payflow Pro Vault payment method
+---
+
+PayPal Payflow Pro Vault payment method processes credit and debit card payments using information stored in the Magento vault. This payment method is available for customers of the United States, Canada, Australia, and New Zealand.
+
+The following conditions must be true to use this payment method:
+
+-  The shopper must be a logged-in customer.
+
+-  The customer must have previously saved their payment information in the Magento vault.
+
+You cannot use this payment method if the customer decides to use a credit or debit card that is not stored in the Magento vault.
+
+If the customer's stored payment information becomes outdated, use the [deletePaymentToken mutation]({{page.baseurl}}/graphql/mutations/delete-payment-token.html) to remove the token. Then perform the actions described in the [PayPal Payflow Pro payment method]({{page.baseurl}}/graphql/) to generate a new token and process the order.
+
+{:.bs-callout-info}
+Use the [`storeConfig` query]({{page.baseurl}}/graphql/queries/store-config.html) and specify the `payment_payflowpro_cc_vault_active` attribute to determine whether the Vault feature is enabled for Payflow Pro.
+
+## Payflow Pro workflow
+
+The following diagram shows the workflow for placing an order when Payflow Pro Vault is the selected payment method.
+
+![PayPal Payflow Pro Vault sequence diagram]({{site.baseurl}}/common/images/graphql/paypal-payflow-pro-vault.svg)
+
+1. Use the [`customerPaymentTokens`]({{page.baseurl}}/graphql/queries/customer-payment-tokens.html) query to retrieve the payment tokens the customer has stored in the vault.
+
+1. Magento returns an array of payment tokens.
+
+1. The client renders the token information, and the customer selects a payment method.
+
+   When the customer selects a stored payment method, the PWA uses the [`setPaymentMethodOnCart`]({{page.baseurl}}/graphql/mutations/set-payment-method.html) mutation to set the payment method to `payflowpro_cc_vault`. The vaulted public hash is passed in the [`payflowpro_cc_vault`](#payflowpro_cc_vault) object.
+
+1. Magento returns a `Cart` object.
+
+1. The client runs the [`placeOrder`]({{page.baseurl}}/graphql/mutations/place-order.html) mutation.
+
+1. Magento sends an authorization request to the gateway.
+
+1. The gateway sends the response to Magento.
+
+1. Magento creates an order and sends an order ID in response to the `placeOrder` mutation.
+
+## Additional Payment information
+
+When you set the payment method to Payflow Pro Vault in the [`setPaymentMethodOnCart`]({{page.baseurl}}/graphql/mutations/set-payment-method.html) mutation, the `payment_method` object must contain a `payflowpro_cc_vault` object, which contains the customer's public hash.
+
+### payflowpro_cc_vault attributes {#payflowpro_cc_vault}
+
+The `payflowpro_cc_vault` object must contain the following attribute:
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`public_hash` | String! | The public hash of the payment token
+
+### Example usage
+
+The following example shows the `setPaymentMethodOnCart` mutation constructed for the Payflow Pro payment method.
+
+**Request:**
+
+```graphql
+mutation {
+  setPaymentMethodOnCart(input: {
+    cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG"
+    payment_method: {
+      code: "payflowpro_cc_vault"
+      payflowpro_cc_vault: {
+          public_hash: "<public-hash-value>"
+        }
+      }
+    }
+  })
+  {
+    cart {
+      selected_payment_method {
+        code
+      }
+  }
+}
+```
+
+**Response:**
+
+```json
+{
+  "data": {
+    "setPaymentMethodOnCart": {
+      "cart": {
+        "selected_payment_method": {
+          "code": "payflowpro_cc_vault"
+        }
+      }
+    }
+  }
+}
+```

src/guides/v2.4/graphql/payment-methods/payflow-pro-vault.md

@@ -0,0 +1,95 @@
+---
+group: graphql
+title: PayPal Payflow Pro payment method
+---
+
+Payflow Pro is a payment gateway that processes debit and credit card payments. It is available for customers of the United States, Canada, Australia, and New Zealand.
+
+Other PayPal solutions have the same GraphQL workflow as Payflow Pro. The information in this topic also applies to the following PayPal solution:
+
+-  Payments Pro
+
+If Payflow Pro has been configured to implement Express Checkout, use the [PayPal Express Checkout for Payflow payment method]({{page.baseurl}}/graphql/payment-methods/payflow-express.html) instead.
+
+{:.bs-callout-info}
+If the `is_active_payment_token_enabler` attribute is set to `1` (true), in future orders, the logged-in customer can use the [Payflow Pro Vault payment method]({{page.baseurl}}/graphql/payment-methods/payflow-pro-vault.html).
+
+## Payflow Pro workflow
+
+The following diagram shows the workflow for placing an order when Payflow Pro is the selected payment method.
+
+![PayPal Payflow Pro sequence diagram]({{site.baseurl}}/common/images/graphql/paypal-payflow-pro.svg)
+
+{% include graphql/payment-methods/payflow-pro-workflow.md %}
+
+## Additional Payment information
+
+When you set the payment method to Payflow Pro in the [`setPaymentMethodOnCart`]({{page.baseurl}}/graphql/mutations/set-payment-method.html) mutation, the `payment_method` object must contain a `payflowpro` object and a `CreditCardDetailsInput` object.
+
+### payflowpro object
+
+The `payflowpro` object must contain the following attributes:
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`cc_details` | CreditCardDetailsInput! | Required input for credit card related information
+`is_active_payment_token_enabler` | Boolean | States whether details about the customer's credit/debit card should be tokenized for later use. Required only if Vault is enabled for PayPal Payflow Pro payment integration.
+
+### CreditCardDetailsInput object
+
+The `CreditCardDetailsInput` object must contain the following attributes:
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`cc_exp_month` | Int! | Credit card expiration month
+`cc_exp_year` | Int! | Credit card expiration year
+`cc_last_4` | Int! | Last four digits of the credit card
+`cc_type` | String! | Credit card type
+
+### Example usage
+
+The following example shows the `setPaymentMethodOnCart` mutation constructed for the Payflow Pro payment method.
+
+**Request:**
+
+```graphql
+mutation {
+  setPaymentMethodOnCart(input: {
+    cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG"
+    payment_method: {
+      code: "payflowpro"
+      payflowpro: {
+        cc_details: {
+          cc_exp_month: 12
+          cc_exp_year: 2023
+          cc_last_4: 1111
+          cc_type: "VI"
+        }
+        is_active_payment_token_enabler: 1
+      }
+    }
+  })
+  {
+    cart {
+      selected_payment_method {
+        code
+      }
+  }
+}
+```
+
+**Response:**
+
+```json
+{
+  "data": {
+    "setPaymentMethodOnCart": {
+      "cart": {
+        "selected_payment_method": {
+          "code": "payflowpro"
+        }
+      }
+    }
+  }
+}
+```

src/guides/v2.4/graphql/payment-methods/payflow-pro.md

@@ -290,6 +290,7 @@ Attribute | Data Type | Description | Default or example value
 `magento_reward_points_review` | String | The number of points for writing a review | null
 `minimum_password_length` | String | The minimum number of characters required for a valid password. <br/>Configuration path: customer/password/minimum_password_length | 6
 `no_route` | String | Contains the URL of the default page that you want to appear when if a 404 “Page not Found” error occurs | `cms/noroute/index`
+`payment_payflowpro_cc_vault_active` | String | Payflow Pro vault status | `0` (inactive) or `1` (active)
 `product_fixed_product_tax_display_setting` | [FixedProductTaxDisplaySettings](#FixedProductTaxDisplaySettings) | Corresponds to the **Display Prices On Product View Page** field. It indicates how Fixed Product Taxes information is displayed on product pages | FPT_DISABLED
 `product_url_suffix` | String | The suffix applied to product pages, such as `.htm` or `.html` | `.html`
 `required_character_classes_number` | String | The number of different character classes required in a password (lowercase, uppercase, digits, special characters). <br/>Configuration path: customer/password/required_character_classes_number | 2