multisafepay/magento2-graphql

MultiSafepay module for Magento 2 GraphQl support

4.0.1 2024-10-30 13:00 UTC

Requires

• php: >=7.2
• magento/framework: 103.0.*
• magento/module-payment: 100.4.*
• magento/module-quote: 101.2.*
• magento/module-quote-graph-ql: 100.4.*
• magento/module-sales: 103.0.*
• multisafepay/magento2-adminhtml: ^1.30
• multisafepay/magento2-core: ^3.8

Suggests

• magento/module-graph-ql: 100.4.*

OSL-3.0

README

MultiSafepay plugin for Magento 2 (GraphQL module)

This module provides GraphQL support for MultiSafepay payments. For a complete installation of all our features, please check out our meta package.

Installation

This module can be installed via composer:

composer require multisafepay/magento2-graphql

Next, enable the module:

bin/magento module:enable MultiSafepay_ConnectCore MultiSafepay_ConnectFrontend MultiSafepay_ConnectAdminhtml MultiSafepay_ConnectGraphQl

Next, run the following commands:

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

Please keep in mind that after installing this module, you will only have graphql compatability and core functionalities.

For a quick installation of all the modules, we recommend using the meta package instead.

Usage

To create an order using GraphQL, please take a look at the Magento manual

Example requests

• Get the issuers and additional data for selected MultiSafepay payment:

query {
    cart(cart_id: "{ CART_ID }") {
        selected_payment_method {
            code
            multisafepay_additional_data {
                image
                is_preselected
            }
            multisafepay_available_issuers {
                code
                description
            }
        }
    }
}

• Get the available payments methods with issuers and additional data for MultiSafepay gateways:

query {
    cart(cart_id: "{ CART_ID }") {
        available_payment_methods {
            code
            title
            multisafepay_available_issuers {
                code
                description
            }
            multisafepay_additional_data {
                image
                is_preselected
            }
        }
    }
}

• setPaymentMethodOnCart query with issuers example:

mutation {
    setPaymentMethodOnCart(input: {
        cart_id: "{ CART_ID }"
        payment_method: {
            code: "multisafepay_mybank"
            multisafepay_mybank: {
                issuer_id: "CT000003-it-1"
            }
        }
    }) {
        cart {
            selected_payment_method {
                code
                multisafepay_additional_data {
                    image
                    is_preselected
                }
            }
        }
    }
}

• To retrieve MultiSafepay request data which includes information about Payment Component, Apple Pay or/and Google Pay, you can use the following query:

query MultisafepayPaymentRequestData {
    multisafepayPaymentRequestData(cart_id: { CART_ID }) {
        apiToken
        apiTokenLifeTime
        cartTotal
        currency
        environment
        locale
        paymentComponentContainerId
        payment_component_template_id
        storeId
        applePayButton {
            applePayButtonId
            getMerchantSessionUrl
            isActive
            additionalTotalItems {
                amount
                label
            }
            cartItems {
                label
                price
            }
        }
        googlePayButton {
            accountId
            googlePayButtonId
            isActive
            mode
            merchantInfo {
                merchantId
                merchantName
            }
        }
        paymentComponentConfig {
            gatewayCode
            paymentMethod
            paymentType
            additionalInfo {
                image
                is_preselected
                vaultCode
            }
            tokens {
                bin
                code
                display
                expired
                expiry_date
                last4
                model
                name_holder
                token
            }
        }
    }
}

• setPaymentMethodOnCart query with payment component payload example: (for more information on how to retrieve the payload, see the MultiSafepay documentation)

mutation {
    setPaymentMethodOnCart(input: {
        cart_id: "{ CART_ID }"
        payment_method: {
            code: "multisafepay_creditcard"
            multisafepay_creditcard: {
                payload: "xxxx"
                tokenize: true
            }
        }
    }) {
        cart {
            selected_payment_method {
                code
                multisafepay_additional_data {
                    image
                    is_preselected
                }
            }
        }
    }
}

• Place order request example. After placing the order, you will receive the multisafepay_payment_url on which the customer should be redirected to for placing a transaction:

mutation {
    placeOrder(input: {cart_id: "{ CART_ID }"}) {
        order {
            order_number
            multisafepay_payment_url {
                payment_url
                error
            }
        }
    }
}

• Request example of a new mutation of restoreQuote for restoring the quote by Cart ID after, for example, an unsuccessfull payment:

mutation {
    restoreQuote(input: {
        cart_id: "{ CART_ID }"
        } 
    )

• Get MultiSafepay payment url from a placed order:

query {
    customer {
        orders(
            pageSize: 10
        ) {
            total_count
            items {
                id
                increment_id
                multisafepay_payment_url
            }
        }
    }
}

Support

You can create issues on our repository. If you need any additional help or support, please contact [e-mail]

We are also available on our Magento Slack channel #multisafepay-payments. Feel free to start a conversation or provide suggestions as to how we can refine our Magento 2 plugin.

A gift for your contribution

We look forward to receiving your input. Have you seen an opportunity to change things for better? We would like to invite you to create a pull request on GitHub. Are you missing something and would like us to fix it? Suggest an improvement by sending us an email or by creating an issue.

What will you get in return? A brand new designed MultiSafepay t-shirt which will make you part of the team!

License

Open Software License (OSL 3.0)

Want to be part of the team?

Are you a developer interested in working at MultiSafepay? View our job openings and feel free to get in touch with us.