REST (Representational State Transfer) API is a standardized architectural style for building web services. It uses HTTP methods such as GET, POST, PUT, and DELETE to perform operations on resources, which are identified by unique URLs (endpoints). Each endpoint corresponds to a specific resource or action, and the API response typically includes associated data in a structured format like JSON or XML.

The Mastercard Magento Plugin makes it easy to integrate with Mastercard Payment Service APIs, allowing merchants to process payments efficiently. It includes tools for both frontend and backend operations.

Frontend Features

Hosted Checkout: A ready-to-use, secure checkout solution.
\n
Hosted Session: A solution that lets you manage the payment experience within your website.
\n
ACH: Enables direct bank-to-bank payments.
\n

Backend Features

The plugin also supports backend operations to help merchants and developers manage payments more effectively:

Payment Integration Setup: Easily configure payment methods.
\n
Mastercard API Credentials Management: Handle and secure your API keys.
\n
3D Secure Enablement: Add an extra layer of security to transactions.
\n
Refund Management: Process refunds quickly and accurately.
\n
Debugging and Logging: Troubleshoot issues with detailed logs.
\n

Mastercard Plugin Integration with Headless Magento

Headless Magento separates the front-end and back-end, giving you the flexibility to customize your system. Here's how you can use the Mastercard Plugin in this setup:

For Developers

Backend Integration

Install the Mastercard Magento Plugin in the Magento Admin module.
\n
Use the plugin’s backend features to configure API credentials, set up payment methods, and manage transactions.
\n

Frontend Development

Build custom payment screens using frameworks like React, Angular, or your preferred frontend technology.
\n
Connect these screens to the Magento backend APIs for seamless payment processing.
\n

Benefits of Headless Integration with the Mastercard Plugin

Flexibility: Customize the user experience on the frontend while using powerful backend tools.
\n
Scalability: Update or replace the frontend easily without disrupting backend operations.
\n
Enhanced Security: Securely handle sensitive data through Mastercard’s APIs and tokenization.
\n
By combining the Mastercard Plugin with Headless Magento, merchants can deliver a payment experience that is tailored, secure, and smooth.
\n

Request Body keys description

cartId: This is the ID of the customer's shopping cart.

paymentMethod: This tells which payment method is being used. For example, if you're using a hosted payment session method, the value will be “tns_hpf”.

method: This represents the payment method code for hosted payment session.
\n
additional_data: This section contains additional details needed for processing the payment session.
\n

Notes

API URL - This is the Magento web address (URL) where the request is sent to create the payment session.
By using this custom REST API, the system will communicate with the gateway to create a session.

Create the payment session only after the billing and shipping addresses are added by utilizing Magento’s default cart and product APIs.

\n","_postman_id":"d4ff6901-aa2c-410d-954c-81a666947598"},{"name":"GraphQL","item":[{"name":"Generate Customer Token","id":"646a78f1-3f9c-48c7-a397-a0cb0bcc2a7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n generateCustomerToken(email: \"customer_email\", password: \"customer_password\") {\n\ttoken\n }\n}\n","variables":""}},"url":"{{Magento base Url}}/graphql","urlObject":{"path":["graphql"],"host":["{{Magento base Url}}"],"query":[],"variable":[]}},"response":[{"id":"d5399a69-819d-4331-b800-accd2c76a099","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n generateCustomerToken(email: \"customer_email\", password: \"customer_password\") {\n\ttoken\n }\n}\n","variables":""}},"url":"https://your-magento-host.com/graphql"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"generateCustomerToken\": {\n \"token\": \"eyJraWQiOiIxIiwiYWxnIjoiSFMyNTYifQ.eyJ1aWQiOjEsInV0eXBpZCI6MywiaWF0IjoxNzQxMTc2NDU5LCJleHAiOjE3NDExODAwNTl9.Yx_RFcp97rPuJ5YtyBYSX9gdW1uA--vXTbzmC9zqCOc\"\n }\n }\n}"},{"id":"d44316d6-db26-40dc-b264-32e82013f114","name":"Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n generateCustomerToken(email: \"customer_email\", password: \"customer_password\") {\n\ttoken\n }\n}\n","variables":""}},"url":"https://your-magento-host.com/graphql"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"The account sign-in was incorrect or your account is disabled temporarily. Please wait and try again later.\",\n \"locations\": [\n {\n \"line\": 2,\n \"column\": 3\n }\n ],\n \"path\": [\n \"generateCustomerToken\"\n ],\n \"extensions\": {\n \"category\": \"graphql-authentication\"\n }\n }\n ],\n \"data\": {\n \"generateCustomerToken\": null\n }\n}"}],"_postman_id":"646a78f1-3f9c-48c7-a397-a0cb0bcc2a7f"},{"name":"Get Customer Cart Id","id":"6ae247e8-0f06-457f-8d81-64b1527959e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{CustomerToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"{\n customerCart{\n\tid\n }\n}\n","variables":""}},"url":"{{Magento base Url}}/graphql","urlObject":{"path":["graphql"],"host":["{{Magento base Url}}"],"query":[],"variable":[]}},"response":[{"id":"0f0ecab0-bc2f-48bc-8e98-a41c068a2904","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"{\n customerCart{\n\tid\n }\n}\n","variables":""}},"url":"https://your-magento-host.com/graphql"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"customerCart\": {\n \"id\": \"7qm2rB8XI5SETkg7LfDxSMDlNGrXvw3I\"\n }\n }\n}"}],"_postman_id":"6ae247e8-0f06-457f-8d81-64b1527959e8"},{"name":"Add Products To Cart","id":"841ee380-08f4-4684-b874-3cc748eea704","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{CustomerToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n addProductsToCart(\n cartId: \"cart_id\"\n cartItems: [\n {\n quantity: 1\n sku: \"sku\"\n }\n ]\n ) {\n cart {\n itemsV2 {\n items {\n product {\n name\n sku\n }\n quantity\n }\n total_count\n page_info {\n page_size\n current_page\n total_pages\n }\n }\n }\n user_errors {\n code\n message\n }\n }\n}\n","variables":""}},"url":"{{Magento base Url}}/graphql","urlObject":{"path":["graphql"],"host":["{{Magento base Url}}"],"query":[],"variable":[]}},"response":[{"id":"8a2c223b-51ae-4906-b218-fb18669c08b9","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n addProductsToCart(\n cartId: \"cart_id\"\n cartItems: [\n {\n quantity: 1\n sku: \"sku\"\n }\n ]\n ) {\n cart {\n itemsV2 {\n items {\n product {\n name\n sku\n }\n quantity\n }\n total_count\n page_info {\n page_size\n current_page\n total_pages\n }\n }\n }\n user_errors {\n code\n message\n }\n }\n}\n","variables":""}},"url":"https://your-magento-host.com/graphql"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"addProductsToCart\": {\n \"cart\": {\n \"itemsV2\": {\n \"items\": [\n {\n \"product\": {\n \"name\": \"Strive Shoulder Pack\",\n \"sku\": \"24-MB04\"\n },\n \"quantity\": 1\n }\n ],\n \"total_count\": 1,\n \"page_info\": {\n \"page_size\": 20,\n \"current_page\": 1,\n \"total_pages\": 1\n }\n }\n },\n \"user_errors\": []\n }\n }\n}"},{"id":"f7918fd6-28ae-487d-b89d-d99b92143205","name":"Failure - Invalid SKU","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n addProductsToCart(\n cartId: \"cart_id\"\n cartItems: [\n {\n quantity: 1\n sku: \"sku\"\n }\n ]\n ) {\n cart {\n itemsV2 {\n items {\n product {\n name\n sku\n }\n quantity\n }\n total_count\n page_info {\n page_size\n current_page\n total_pages\n }\n }\n }\n user_errors {\n code\n message\n }\n }\n}\n","variables":""}},"url":"https://your-magento-host.com/graphql"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"addProductsToCart\": {\n \"cart\": {\n \"itemsV2\": {\n \"items\": [\n {\n \"product\": {\n \"name\": \"Strive Shoulder Pack\",\n \"sku\": \"24-MB04\"\n },\n \"quantity\": 1\n }\n ],\n \"total_count\": 1,\n \"page_info\": {\n \"page_size\": 20,\n \"current_page\": 1,\n \"total_pages\": 1\n }\n }\n },\n \"user_errors\": [\n {\n \"code\": \"PRODUCT_NOT_FOUND\",\n \"message\": \"Could not find a product with SKU \\\"24-MB0676\\\"\"\n }\n ]\n }\n }\n}"}],"_postman_id":"841ee380-08f4-4684-b874-3cc748eea704"},{"name":"Set Shipping Address","id":"394b2f1a-ca28-45e5-a38d-f04f3cd750aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{CustomerToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n setShippingAddressesOnCart(\n input: {\n cart_id: \"cart_id\",\n shipping_addresses: [\n {\n address: {\n firstname: \"John\",\n lastname: \"Doe\",\n street: [\"123 Main St\"],\n city: \"Los Angeles\",\n region: \"CA\",\n postcode: \"90001\",\n country_code: \"US\",\n telephone: \"555-555-5555\",\n save_in_address_book: false\n }\n }\n ]\n }\n ) {\n cart {\n shipping_addresses {\n firstname\n lastname\n street\n city\n region {\n label\n }\n postcode\n country {\n code\n }\n telephone\n }\n }\n }\n}","variables":""}},"url":"{{Magento base Url}}/graphql","urlObject":{"path":["graphql"],"host":["{{Magento base Url}}"],"query":[],"variable":[]}},"response":[{"id":"6a9bda4a-6c74-4fc7-93bb-f4a094bbb7ac","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n setShippingAddressesOnCart(\n input: {\n cart_id: \"cart_id\",\n shipping_addresses: [\n {\n address: {\n firstname: \"John\",\n lastname: \"Doe\",\n street: [\"123 Main St\"],\n city: \"Los Angeles\",\n region: \"CA\",\n postcode: \"90001\",\n country_code: \"US\",\n telephone: \"555-555-5555\",\n save_in_address_book: false\n }\n }\n ]\n }\n ) {\n cart {\n shipping_addresses {\n firstname\n lastname\n street\n city\n region {\n label\n }\n postcode\n country {\n code\n }\n telephone\n }\n }\n }\n}","variables":""}},"url":"https://your-magento-host.com/graphql"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"setShippingAddressesOnCart\": {\n \"cart\": {\n \"shipping_addresses\": [\n {\n \"firstname\": \"John\",\n \"lastname\": \"Doe\",\n \"street\": [\n \"123 Main St\"\n ],\n \"city\": \"Los Angeles\",\n \"region\": {\n \"label\": \"California\"\n },\n \"postcode\": \"90001\",\n \"country\": {\n \"code\": \"US\"\n },\n \"telephone\": \"555-555-5555\"\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"394b2f1a-ca28-45e5-a38d-f04f3cd750aa"},{"name":"Set Billing Address","id":"d740e720-5e9e-4a13-b63a-c30ddf3c6fde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{CustomerToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n setBillingAddressOnCart(\n input: {\n cart_id: \"cart_id\"\n billing_address: {\n address: {\n firstname: \"John\"\n lastname: \"Doe\"\n street: [\"123 Main St\"]\n city: \"Los Angeles\"\n region: \"CA\"\n postcode: \"90001\"\n country_code: \"US\"\n telephone: \"555-555-5555\"\n save_in_address_book: false\n }\n same_as_shipping: false\n }\n }\n ) {\n cart {\n billing_address {\n firstname\n lastname\n street\n city\n region {\n label\n }\n postcode\n country {\n code\n }\n telephone\n }\n }\n }\n}","variables":""}},"url":"{{Magento base Url}}/graphql","urlObject":{"path":["graphql"],"host":["{{Magento base Url}}"],"query":[],"variable":[]}},"response":[{"id":"ee1df220-ecae-4d13-84ec-928009f03492","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n setBillingAddressOnCart(\n input: {\n cart_id: \"cart_id\"\n billing_address: {\n address: {\n firstname: \"John\"\n lastname: \"Doe\"\n street: [\"123 Main St\"]\n city: \"Los Angeles\"\n region: \"CA\"\n postcode: \"90001\"\n country_code: \"US\"\n telephone: \"555-555-5555\"\n save_in_address_book: false\n }\n same_as_shipping: false\n }\n }\n ) {\n cart {\n billing_address {\n firstname\n lastname\n street\n city\n region {\n label\n }\n postcode\n country {\n code\n }\n telephone\n }\n }\n }\n}","variables":""}},"url":"https://your-magento-host.com/graphql"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"setBillingAddressOnCart\": {\n \"cart\": {\n \"billing_address\": {\n \"firstname\": \"John\",\n \"lastname\": \"Doe\",\n \"street\": [\n \"123 Main St\"\n ],\n \"city\": \"Los Angeles\",\n \"region\": {\n \"label\": \"California\"\n },\n \"postcode\": \"90001\",\n \"country\": {\n \"code\": \"US\"\n },\n \"telephone\": \"555-555-5555\"\n }\n }\n }\n }\n}"}],"_postman_id":"d740e720-5e9e-4a13-b63a-c30ddf3c6fde"},{"name":"Set Shipping Method","id":"aea6964a-0797-4620-8338-48dba7351d6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{CustomerToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n setShippingMethodsOnCart(\n input: {\n cart_id: \"cart_id\",\n shipping_methods: [\n {\n carrier_code: \"tablerate\"\n method_code: \"bestway\"\n }\n ]\n }\n ) {\n cart {\n shipping_addresses {\n selected_shipping_method {\n carrier_code\n carrier_title\n method_code\n method_title\n amount {\n value\n currency\n }\n }\n }\n }\n }\n}","variables":""}},"url":"{{Magento base Url}}/graphql","urlObject":{"path":["graphql"],"host":["{{Magento base Url}}"],"query":[],"variable":[]}},"response":[{"id":"95d5a9cb-e95e-4535-bb13-f1c7b2875e6b","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n setShippingMethodsOnCart(\n input: {\n cart_id: \"cart_id\",\n shipping_methods: [\n {\n carrier_code: \"tablerate\"\n method_code: \"bestway\"\n }\n ]\n }\n ) {\n cart {\n shipping_addresses {\n selected_shipping_method {\n carrier_code\n carrier_title\n method_code\n method_title\n amount {\n value\n currency\n }\n }\n }\n }\n }\n}","variables":""}},"url":"https://your-magento-host.com/graphql"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"setShippingMethodsOnCart\": {\n \"cart\": {\n \"shipping_addresses\": [\n {\n \"selected_shipping_method\": {\n \"carrier_code\": \"tablerate\",\n \"carrier_title\": \"Best Way\",\n \"method_code\": \"bestway\",\n \"method_title\": \"Table Rate\",\n \"amount\": {\n \"value\": 15,\n \"currency\": \"USD\"\n }\n }\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"aea6964a-0797-4620-8338-48dba7351d6f"},{"name":"Create Payment Session","id":"497eb923-907f-4295-88b5-9c6586ce6e00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{CustomerToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n createNewPaymentSession(input: { cart_id:\"cart_id\", payment_method: { code: \"tns_hpf\" } }) {\n\tid\n\tversion\n }\n}\n\n","variables":""}},"url":"{{Magento base Url}}/graphql","urlObject":{"path":["graphql"],"host":["{{Magento base Url}}"],"query":[],"variable":[]}},"response":[{"id":"cc5494a1-ac19-4eac-87a6-f9d4932a8cf5","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n createNewPaymentSession(input: { cart_id:\"cart_id\", payment_method: { code: \"tns_hpf\" } }) {\n\tid\n\tversion\n }\n}\n\n","variables":""}},"url":"https://your-magento-host.com/graphql"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"createNewPaymentSession\": {\n \"id\": \"SESSION0002052044737G9649310F29\",\n \"version\": \"b6db5b1001\"\n }\n }\n}"}],"_postman_id":"497eb923-907f-4295-88b5-9c6586ce6e00"},{"name":"Update Payment Session","id":"433aaa9d-2145-426f-a82b-8025b569c02d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":"{{Merchant Password}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{ \n \"sourceOfFunds\": {\n \t\"type\": \"CARD\",\n \t\"provided\": {\n \t\"card\": {\n \t\"number\": \"5123450000000008\",\n \t\"expiry\": {\n \t\"month\": \"01\",\n \t\"year\": \"39\"\n \t},\n \t\"securityCode\": \"100\"\n \t}\n \t}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://mtf.gateway.mastercard.com/api/rest/version/100/merchant/{{Merchant ID}}/session/SESSION_ID","urlObject":{"protocol":"https","path":["api","rest","version","100","merchant","{{Merchant ID}}","session","SESSION_ID"],"host":["mtf","gateway","mastercard","com"],"query":[],"variable":[]}},"response":[{"id":"2178a7fd-1849-4bb3-a085-892212a83762","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{ \n \"sourceOfFunds\": {\n \t\"type\": \"CARD\",\n \t\"provided\": {\n \t\"card\": {\n \t\"number\": \"5123450000000008\",\n \t\"expiry\": {\n \t\"month\": \"01\",\n \t\"year\": \"39\"\n \t},\n \t\"securityCode\": \"100\"\n \t}\n \t}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://mtf.gateway.mastercard.com/api/rest/version/100/merchant/MID/session/SESSION_ID"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"billing\": {\n \"address\": {\n \"city\": \"California\",\n \"company\": \"Company\",\n \"country\": \"USA\",\n \"postcodeZip\": \"sd23 4qa\",\n \"stateProvince\": \"CA\",\n \"street\": \"Street Address\"\n }\n },\n \"customer\": {\n \"email\": \"roni_cost@example.com\",\n \"firstName\": \"john\",\n \"lastName\": \"harrison\",\n \"phone\": \"2313131312\"\n },\n \"interaction\": {\n \"displayControl\": {\n \"billingAddress\": \"HIDE\",\n \"customerEmail\": \"HIDE\",\n \"shipping\": \"HIDE\"\n },\n \"operation\": \"NONE\",\n \"successIndicator\": \"99700aa14120403f\"\n },\n \"merchant\": \"FINGENTDCC\",\n \"order\": {\n \"amount\": \"50.00\",\n \"currency\": \"USD\",\n \"description\": \"Ordered Goods\",\n \"id\": \"CITY_DEMO_246_000000281\",\n \"notificationUrl\": \"https://demo-citi-magentoce-mc.fingent.dev/tns/webhook/response/\",\n \"reference\": \"CITY_DEMO_246_000000281\"\n },\n \"partnerSolutionId\": \"Magento_Community_2.4.7-p3__2.4.4.0\",\n \"session\": {\n \"id\": \"SESSION0002868644456E7473638G94\",\n \"updateStatus\": \"SUCCESS\",\n \"version\": \"9482c24802\"\n },\n \"shipping\": {\n \"address\": {\n \"city\": \"California\",\n \"company\": \"Company\",\n \"country\": \"USA\",\n \"postcodeZip\": \"sd23 4qa\",\n \"stateProvince\": \"CA\",\n \"street\": \"alpha st\"\n },\n \"contact\": {\n \"email\": \"roni_cost@example.com\",\n \"firstName\": \"john\",\n \"lastName\": \"harrison\",\n \"phone\": \"2313131312\"\n }\n },\n \"sourceOfFunds\": {\n \"provided\": {\n \"card\": {\n \"brand\": \"MASTERCARD\",\n \"expiry\": {\n \"month\": \"1\",\n \"year\": \"39\"\n },\n \"fundingMethod\": \"DEBIT\",\n \"number\": \"512345xxxxxx0008\",\n \"scheme\": \"MASTERCARD\",\n \"securityCode\": \"xxx\"\n }\n },\n \"type\": \"CARD\"\n },\n \"transaction\": {\n \"reference\": \"CITY_DEMO_246_000000281-67c90f3311a39\",\n \"source\": \"INTERNET\"\n },\n \"version\": \"100\"\n}"}],"_postman_id":"433aaa9d-2145-426f-a82b-8025b569c02d"},{"name":"Place Order","id":"137b6a46-437c-4f6a-9be2-d66d174a25c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{CustomerToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n setPaymentMethodAndPlaceOrder(\n\tinput: { cart_id: \"cart_id\", payment_method: { code: \"tns_hpf\" } }\n ) {\n\torder {\n \torder_id\n \torder_number\n\t}\n }\n}\n","variables":""}},"url":"{{Magento base Url}}/graphql","urlObject":{"path":["graphql"],"host":["{{Magento base Url}}"],"query":[],"variable":[]}},"response":[{"id":"e3cc88ca-c465-4689-a3d8-3afcc659c584","name":"Error - Invalid payment","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation {\n setPaymentMethodAndPlaceOrder(\n\tinput: { cart_id: \"cart_id\", payment_method: { code: \"tns_hpf\" } }\n ) {\n\torder {\n \torder_id\n \torder_number\n\t}\n }\n}\n","variables":""}},"url":"https://your-magento-host.com/graphql"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unable to place order: Transaction has been declined. Please try again later.\",\n \"locations\": [\n {\n \"line\": 2,\n \"column\": 3\n }\n ],\n \"path\": [\n \"setPaymentMethodAndPlaceOrder\"\n ],\n \"extensions\": {\n \"category\": \"graphql-input\"\n }\n }\n ],\n \"data\": {\n \"setPaymentMethodAndPlaceOrder\": null\n }\n}"}],"_postman_id":"137b6a46-437c-4f6a-9be2-d66d174a25c0"}],"id":"1751844c-2576-4b60-ac75-ddc291cdb6a8","description":"

GraphQL is a query language and runtime for APIs that allows clients to request only the specific data they need. Unlike REST, which often returns fixed structures of data, GraphQL enables clients to define the structure of the response, making it more flexible and efficient. Operations (queries, mutations, and subscriptions) are handled via a single endpoint.
The plugin supports a Headless Magento architecture, enabling businesses to decouple the front-end and backend. This approach allows greater customization and flexibility:

The front end can be built using modern technologies like React or Angular.
\n
The backend Magento admin module handles core payment and transactional functionalities.
\n

Using GraphQL, the plugin facilitates dynamic interactions between the decoupled front-end and backend, ensuring a responsive and tailored user interface.

GraphQL Schema Keywords

mutation: In GraphQL, a mutation is used for writing or modifying data, such as creating, updating, or deleting records. Here, the mutation is used to authenticate a customer.

generateCustomerToken: This is the GraphQL field (or operation) that handles customer authentication. It takes the customer's email and password as inputs and generates a token for the authenticated customer.

email: The email address of the customer.

password: The password of the customer.

token: After the mutation is successfully executed, the response will include a token. This is a string value that represents an authentication token, which can be used in subsequent API requests to authenticate the customer.

customerCart: It's a query provided by Magento to fetch details about the customer's cart.

id: Requesting the cart ID of the current customer.

setPaymentMethodAndPlaceOrder: This is the mutation operation that places an order and sets the payment method for the provided cart.

cart_id: This is the customer’s cart id for which the order will be placed. Replace \"cart_id\" with the actual cart ID of the customer.

payment_method: This is an object that specifies the payment method to be used for the order. method_code: \"tns_hpf\" or “tns_hosted”. This represents the payment method code.

\n","_postman_id":"1751844c-2576-4b60-ac75-ddc291cdb6a8"}]}