Square Payment Gateway

Content Type: Module


A Square Payment Gateway module can allow users to make payments using credit or debit cards. The module would typically integrate with the Square API to handle the payment processing, including the authorization, capture, and refund of payments. Users can enter their payment details directly into the Mendix application, and the module would securely transmit the payment information to Square for processing.




1. Goto https://developer.squareup.com/us/en and signup for an account. 
2. Create a new business and app in the square developer dashboard to get the access token and location ID (you get the location ID at bottom of left menu).
3. Go to navigation in your application and add Configuration page, CustomersOverview page, CatalogMenu page, CreateCheckout page,  InvoicesOverview page, PaymentsOverview page, TransactionsOverview page,TeamMembersOverview page and call a microflow ACT_CreateCard to the responsive menu list.
4. For the Configuration page create an object using the entity Configuration, for the CatalogMenu page create an object using the entity MenuItemdata, and CreateCheckout page create an object using the entity CheckoutMenu in the navigation.
5. Add module roles Administrator, User in the App security level.
6. Run your app locally and open configuration page. Paste your access token, location ID (for getting access token and location ID refer point no 3).
7. Open the CustomerOverview page and create a new customer for the default test account. 

Features and limitations

This module allows you to create 

1.Orders : Create orders for the catalog menu items

2.Payments: Create payments for the orders

3.Invoice: Create invoice for the orders

4.Checkout: Create checkout data and payment for the checkout.


  • Mendix modeler 9.20.0 and above.
  • Community Commons Module.


  •       Download the module from marketplace.
  •       Download Community Commons module from marketplace.


Administrator:  Add module roles Administrator and assign from Project Module.

User:  Add module roles User and assign from Project Module.

Community Commons:  Add module roles Administrator, User for the Community Commons in the app security level.




Version: 1.0.0
Framework Version: 9.20.0
Release Notes: Version 1.0.0