GraphQL module

Introducing Buckaroo's revolutionary GraphQL extension for the popular Buckaroo Magento 2 Payments Plugin—an essential enhancement for our cutting-edge Hÿva React checkout extension.
GraphQL is a powerful query language for APIs, providing a comprehensive and understandable description of your API's data. Clients can request exactly what they need, optimizing performance and enabling easy API evolution over time.
Unlock new e-commerce efficiency and flexibility with Buckaroo's latest innovation. Upgrade your online business experience today!

Requirements

To utilize the plugin, you must use:

• Magento Open Source version 2.4.x
• Buckaroo Magento 2 Payment plugin v1.43.0 or higher.

Installation

Install the module composer by running the following command: composer require buckaroo/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 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.

For iDEAL we have the following 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
}

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 the following 3 steps:

• Set the payment method on the card 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.

For iDEAL we have the following 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.

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
}