MyTPE Pay Integration Guide

This guide explains the architecture for integrating MyTPE Pay into external systems (Odoo, WordPress, WooCommerce, Shopify, or any custom solution).

What You'll Achieve

By following this guide, your system will be able to:

• Automate Links: Automatically create payment links when orders are confirmed.
• Sync Instances: Map your physical/digital stores to MyTPE Instances.
• Display Payment URLs: Present the generated payment_link to customers for checkout.
• Real-time Status: Update order statuses (Pending → Paid) instantly via Webhooks.
• Inventory Management: Handle limited stock automatically using limited payment modes.

Key Concept: ID Mapping

The most critical part of this integration is ID Mapping. You must store MyTPE Pay IDs alongside your local database records. This creates a bridge between your ERP/CMS and our banking gateway.

Integration Journey

Here is the complete journey from authentication to live payment processing.

Data Mapping Strategy

1. The Hierarchy

You need to replicate or map to our 3-level hierarchy to ensure your reports match our bank settlements.

Complete Integration Flow

Scenario: E-commerce Order

This sequence diagram details the logical flow between your server and the MyTPE API.

Critical: Displaying the Payment Link

{
  "data": {
    "id": "paylink_new456",
    "payment_link": "https://frontdev.mytpe.app/pay/limited-offer",
    ...
  }
}

Integration Scenarios

1. WordPress / WooCommerce

If you are building a plugin:

1. Settings Page: Add a field to input API Key/Secret.
2. Instance Select: Add a dropdown to select which "MyTPE Instance" corresponds to this WooCommerce store.
3. Checkout Logic:
   • Link Type: Use dynamic for fixed-price products, static for donations/custom amounts
   • Payment Mode: Use one_shot for standard checkout
   • Link Storage: Store link_id in wp_postmeta for the Order
   • Slug: Use wc_order_{id} for the link slug
   • Display: Add a "Complete Payment" button on the order confirmation page that links to payment_link

Example Button:

<a href="<?php echo $payment_link; ?>" class="button">
  Complete Payment
</a>

2. Odoo ERP

If you are building an Odoo module:

1. Company Settings: Add mytpe_instance_id to the res.company model.
2. Invoicing: When creating an invoice, generate a Link with type one_shot.
3. Matching: Store the link_id in a custom field x_mytpe_link_id.
4. Display: Add the payment_link to the invoice email template
5. Reconciliation: The webhook should trigger an account.payment registration.

Example Email Template:

<p>
  <a href="${object.x_mytpe_payment_link}"
     style="background: #007bff; color: white; padding: 10px 20px;">
    Pay Invoice Online
  </a>
</p>

3. Multi-Tenant SaaS

If you run a platform (e.g., a food delivery app) with many merchants:

1. Mapping: Each Merchant in your DB needs their own mytpe_instance_id.
2. Link Generation: When a customer orders, create a payment link using the merchant's instance ID
3. Display: Show the payment_link in the order summary
4. Routing: When a webhook arrives, use the link_id to determine which merchant's order this belongs to.

Payment Link Types & Modes

Understanding when to use each type and mode is crucial:

Link Types

Payment Modes (Dynamic Links Only)

Best Practices

1. Always Store the Link ID

2. Always Display the payment_link

3. Error Handling Strategy

4. Webhook Security

Quick Integration Checklist

• Authentication: Login & store keys securely.
• Mapping: Map mytpe_instance_id to your Store/Company.
• Creation: Generate links using POST /links/store and save the link_id.
• Display: Show the payment_link URL to customers via button/QR/email.
• Webhooks: Verify signatures and update orders using link_id.
• Testing: Test with one_shot mode first to ensure auto-closing works.

Common Pitfalls to Avoid

Testing Your Integration