GraphQL module

      GraphQL module


        Article Summary

        Buckaroo Magento2 GraphQL module

        We created a additional GraphQL module for the Buckaroo Magento 2 Payments Plugin.

        This plugin is required for our Hÿva React checkout module.

        What is GraphQL?
        GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.

        Installation

        • Install the module composer by running the following command:
          composer require buckaroo/module-magento2graphql
        • Enable the module by running the following command:
          php bin/magento module:enable Buckaroo_Magento2Graphql
        • Apply database updates by running the following command:
          php bin/magento setup:upgrade
        • Flush the cache by running the following command:
          php bin/magento cache:flush

        Usage (Example requests)

        Get the available payments methods with additional data for gateways:

        query {
            cart(cart_id: "{ CART_ID }") {
                available_payment_methods {
                    code
                    title
                    buckaroo_additional {
                        key
                        values {
                            name
                            code
                            img
                        }
                        value
                    }
                }
            }
        }
        


        Place order request example:

        In order to place a order you will need to execute the following 3 steps:

        • Set the payment method on the cart with the required additional parameters using the default setPaymentMethodOnCart and the buckaroo_additional property.
        • Set the return url using our custom migration setBuckarooReturnUrl required in order for the payment engine to redirect back to your application after the payment was completed/canceled/failed.
        • Finally execute the the default placeOrder that will return a redirect url for the payment engine to complete the payment.

        iDEAL request example:

          mutation doBuckarooPayment(
          $cartId: String!
          $returnUrl: String!
          $methodCode: String!
        ) {
          setPaymentMethodOnCart(
            input: {
              cart_id: $cartId
              payment_method: {
                code: $methodCode
                buckaroo_additional: { buckaroo_magento2_ideal: { issuer: "ABNANL2A" } }
              }
            }
          ) {
            cart {
              items {
                product {
                  name
                  sku
                }
              }
            }
          }
          setBuckarooReturnUrl(input: { return_url: $returnUrl, cart_id: $cartId }) {
            success
          }
          placeOrder(input: { cart_id: $cartId }) {
            order {
              order_number
              buckaroo_additional {
                redirect
                transaction_id
                data {
                  key
                  value
                }
              }
            }
          }
        }
        
        

        After this migration is performed you will need to store the buckaroo transaction_id and redirect the user to complete the payment.

        Retrieve the payment status

        In order to get the payment status after the user is redirected back we will use our custom migration buckarooPaymentTransactionStatus that will need the stored transaction_id.

        mutation buckarooPaymentTransactionStatus(input: { transaction_id: "E397CF4C24E64AA299F45246F9906F45" }) {
          payment_status,
          status_code
        }
        



        Please contact Buckaroo support if you have any technical questions.  
        E-mail: support@buckaroo.nl

        Our telephone number and contact details of other departments can be found in the Buckaroo Payment Plaza under "Contact details" at the bottom left of the screen.


        Was this article helpful?

        What's Next