# Layup MCP MCP > Layup MCP connects your AI agent directly to an e-commerce lay-by system. It lets you check order statuses, track deposits, and retrieve detailed customer records without leaving your chat environment. You can programmatically create new lay-by orders or manually record a deposit right from conversation. ## Overview - **Category:** ecommerce - **Price:** Free - **Tags:** lay-by, checkout-gateway, order-tracking, deposit-management, financial-transactions ## Description Managing payments for installment plans usually means jumping between three different dashboards: the core inventory system, the payment gateway, and the CRM. It's slow, and things get missed. This MCP connects your agent directly to Layup’s operational account. You can ask it to check the remaining balance on a specific order or list all deposits recorded last month. Need to start a new lay-by? Your agent handles that too. By connecting this MCP via Vinkius, you're giving your AI client instant access to complex payment logic and customer history. It’s about getting accurate financial data—whether it's fetching targeted payment details or cross-referencing buyer metrics with internal logs—all in one conversational flow. ## Tools ### cancel_order Voids a lay-by order that was previously initiated. ### create_deposit Manually records a new deposit against an active lay-by plan. ### create_order Initializes the structure for a brand new lay-by order. ### get_customer Pulls specific details about a customer based on provided identifiers. ### get_order Retrieves all necessary information for a given lay-by order ID. ### get_payment Fetches the complete history and details of a specific payment transaction. ### list_customers Reads a list of all saved shopper profiles in your account. ### list_orders Retrieves a comprehensive list of currently active lay-by payment plan orders. ### list_payments Gathers every single payment transaction associated with an order or customer. ## Prompt Examples **Prompt:** ``` Find order ID 900 and tell me its completion balance. ``` **Response:** ``` Understood. Fetching from your Layup module... Order 900 holds a remaining balance of 20.00ZAR with status set as Incomplete. ``` **Prompt:** ``` Fetch all recorded incoming deposits. ``` **Response:** ``` Connecting to API... You have 15 recent deposit lines mapped over your active lay-bys in the last window. ``` **Prompt:** ``` Search for customer details on the Layup platform. ``` **Response:** ``` Querying customer list... Retrieved 3 profiles. Should I filter by email? ``` ## Capabilities ### Check order status Retrieve all parameters for a specific lay-by order. ### List active orders and payments Fetch lists of all current payment plans or view every transaction linked to an order. ### Manage customer data Read saved shopper profiles or retrieve specific buyer information. ### Handle deposits and orders Manually register a deposit or initialize an entire new lay-by order programmatically. ### Cancel transactions Void an existing lay-by order if necessary. ## Use Cases ### Investigating a payment dispute A customer calls about a missing deposit. Instead of manually searching three systems, the agent asks their AI client to run `list_payments` for that user and then use `get_payment` on the specific date in question. The result shows exactly when the payment was processed and if it matched the order ID. ### Onboarding a new high-value customer A sales rep needs to start tracking an installment plan for a big sale. They prompt their agent, which uses `create_order` to set up the initial lay-by record and then runs `get_customer` on the buyer's email to ensure all contact details are logged. ### End of month reconciliation The ops team needs a snapshot of every order that is currently active. They ask their agent to execute `list_orders`, which returns a clean, filterable list they can use for billing reports, saving hours of manual spreadsheet work. ## Benefits - Audit payment plans quickly. Instead of checking multiple internal sheets, use `list_orders` to pull a clean list of every active installment plan in one go. - Instantly check customer funds. If a support agent needs to know the current balance, using `get_order` provides all necessary details without leaving the chat window. - Record payments on the fly. When a deposit comes in, use `create_deposit` to register it manually and keep your records up-to-date right away. - Streamline setup time. Use `list_customers` to pull basic profile data, then use `get_customer` if you need specific financial parameters for that shopper. - Process changes easily. Need to void a purchase? Call `cancel_order`. It's a single step instead of submitting a manual reversal form. ## How It Works The bottom line is: you tell your AI what you need to know about a lay-by transaction, and it executes the query against Layup’s system. 1. Subscribe to this MCP and enter your Layup Merchant API Key. 2. Your AI agent authenticates the connection, giving it permission to access payment and customer data. 3. You prompt the agent with a specific request—like 'What's the status for order 123?'—and get an immediate, accurate response. ## Frequently Asked Questions **How do I get started?** Subscribe, enter your API credentials (your secret token from **Layup Dashboard → Developer Settings → API Keys**), and you're ready. No code, no environment files, no endpoints — just connect and start managing your orders through your AI agent. **Can my AI agent check the remaining balance on an active order?** Yes! Provide the Order target ID to the agent. It utilizes the `get_order` tool returning exact metrics on money received vs pending values. It aggregates everything in conversational format so you don't jump windows. **What happens when I need to create a manual dynamic lay-by in chat?** Just specify the item price, customer token, and configuration. The AI agent executes a `create_order` action connecting via the payload and creates proper links. The shopper gets billed correctly, saving you minutes of UI clicking. **Can I query an exact list of all historically recorded buyers/customers?** Absolutely. Ask the agent to list all stored customers. It compiles email arrays, reference ID trackers, phone tags — perfect for store leads and analysts evaluating buyer records without exporting flat files. **If I run `cancel_order` with an invalid or already voided order ID, how does the MCP report the failure?** The API returns a clear error code and message directly to your agent. This instant feedback tells you exactly why cancellation failed, stopping guesswork and letting you correct the data immediately. **When I use `list_payments`, how can I cross-reference payment details across multiple distinct orders?** The tool provides detailed metadata for every payment record. You can group or filter by transaction IDs, allowing you to see if a single deposit was applied against several different lay-by order numbers. **If I run `list_orders` and the dataset is massive, does your MCP handle pagination limits?** Yes. The MCP automatically manages large datasets by sending results in manageable chunks. Your agent simply requests the next page until all active lay-by payment plan orders are retrieved. **What prerequisite data must I provide when using `create_order` to ensure the new lay-by record is valid?** You must supply validated customer IDs and specific product identifiers. The MCP needs these keys upfront to initialize the lay-by process correctly, guaranteeing a complete record from the start.