handlePayflowProResponse mutation | Magento 2 Developer Documentation

The handlePayflowProResponse mutation sends the silent post data that the client received from the Payflow Pro gateway to the Magento server. The content of this payload varies based on factors such as the merchant’s location, the items purchased, and the billing/shipping addresses. The following is an example payload:

'BILLTOCITY=CityM&AMT=0.00&BILLTOSTREET=Green+str,+67&VISACARDLEVEL=12&SHIPTOCITY=CityM'
'&NAMETOSHIP=John+Smith&ZIP=75477&BILLTOLASTNAME=Smith&BILLTOFIRSTNAME=John'
'&RESPMSG=Verified&PROCCVV2=M&STATETOSHIP=AL&NAME=John+Smith&BILLTOZIP=75477&CVV2MATCH=Y'
'&PNREF=B70CCC236815&ZIPTOSHIP=75477&SHIPTOCOUNTRY=US&SHIPTOSTREET=Green+str,+67&CITY=CityM'
'&HOSTCODE=A&LASTNAME=Smith&STATE=AL&SECURETOKEN=MYSECURETOKEN&CITYTOSHIP=CityM&COUNTRYTOSHIP=US'
'&AVSDATA=YNY&ACCT=1111&AUTHCODE=111PNI&FIRSTNAME=John&RESULT=0&IAVS=N&POSTFPSMSG=No+Rules+Triggered&'
'BILLTOSTATE=AL&BILLTOCOUNTRY=US&EXPDATE=0222&CARDTYPE=0&PREFPSMSG=No+Rules+Triggered&SHIPTOZIP=75477&'
'PROCAVS=A&COUNTRY=US&AVSZIP=N&ADDRESS=Green+str,+67&BILLTONAME=John+Smith&'
'ADDRESSTOSHIP=Green+str,+67&'
'AVSADDR=Y&SECURETOKENID=MYSECURETOKENID&SHIPTOSTATE=AL&TRANSTIME=2019-06-24+07%3A53%3A10'

See Paypal Payflow Pro payment method for detailed information about the workflow of PayPal Payflow Pro transactions.

Syntax

handlePayflowProResponse(input: PayflowProResponseInput!): PayflowProResponseOutput

Example usage

The following example sends the Payflow Pro payload to Magento:

Request:

mutation {
  handlePayflowProResponse(
    input: {
      cart_id: "Po1WkfK7d3vZE0qga610NwJIbxgqllpt"
      paypal_payload: "$payload"
    }
  ){
    cart {
      selected_payment_method {
        code
      }
    }
  }
}

Response:

{
  "data": {
    "handlePayflowProResponse": {
      "cart": {
        "selected_payment_method": {
          "code": "payflowpro",
        }
      }
    }
  }
}

Input attributes

The PayflowProResponseInput object must contain the cart_id and paypal_payload attributes.

Attribute	Data Type	Description
`cart_id`	String!	The unique ID that identifies the customer’s cart
`paypal_payload`	String!	The payload returned from PayPal

Output attributes

The PayflowProResponseOutput contains a Cart object.

Cart object

Attribute	Data Type	Description
`applied_coupon`	`AppliedCoupon`	Deprecated. Use `applied_coupons` instead
`applied_coupons`	[`AppliedCoupon`]	An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code
`applied_gift_cards`	[`AppliedGiftCard`]	An array of `AppliedGiftCard` objects. An `AppliedGiftCard` object contains the `code` text attribute, which specifies the gift card code. `applied_gift_cards` is a Commerce-only attribute, defined in the GiftCardAccountGraphQl module
`applied_store_credit`	`AppliedStoreCredit`	Contains store credit information applied to the cart. `applied_store_credit` is a Commerce-only attribute, defined in the CustomerBalanceGraphQl module
`available_payment_methods`	[AvailablePaymentMethod]	Available payment methods
`billing_address`	BillingCartAddress	Contains the billing address specified in the customer’s cart
`email`	String	The customer’s email address
`id`	ID!	The ID of the cart
`is_virtual`	Boolean!	Indicates whether the cart contains only virtual products
`items`	[CartItemInterface]	Contains the items in the customer’s cart
`prices`	CartPrices	Contains subtotals and totals
`selected_payment_method`	SelectedPaymentMethod	Selected payment method
`shipping_addresses`	[ShippingCartAddress]!	Contains one or more shipping addresses
`total_quantity`	Float!	Total Quantity of products in the cart

Cart query output provides more information about the Cart object.