Plexy
Pay APIGate APIDashboard
Pay APIGate APIDashboard
  1. Payments
  • Overview
  • Authorization
  • Webhooks
  • API Errors
  • Test Scenarios
  • Ecommerce Plugins
  • API
    • Payments
      • Overview
      • Payment Links
        • Create Payment Link
        • List Payment Links
        • Retrieve Payment Link by Order Reference
        • Cancel Payment Link
        • Retrieve Payment Link
        • Update Payment Link Expiration
        • Retrieve Payment Links Statistics
      • Reccurent Payments
        • Create Merchant-Initiated Payment
      • Direct Payments
        • Get Keys
        • Create Host-to-Host Payment
      • Transaction Management
        • Find Transaction's History by ID
        • Find Transaction by Payment Link ID
        • Find Transaction by ID
        • Find Transaction by Order reference
      • Payment Management
        • Cancel Payment
        • Capture Payment
        • Process Refund
      • Split Requests
        • Create
        • List
        • Update
        • Get By Id
        • Delete
      • Settlement Payment Order
        • Create
        • Get by id
        • List
    • Payouts
      • Retrieve Payout Transactions
      • Process Payout
      • Save Card for Payouts
    • Customers
      • Get Customer's Card Tokens
      • List Customers
      • Create Customer
      • Get Customer by ID
      • Get Customer's Transactions
    • Merchants
      • Payment Beneficiary
        • Create
        • Update
        • Gey By Id
        • List
        • Transfer from beneficiary balance to merchant balance
        • Create manual settlement for beneficiary
      • Retrieve Merchant's Details
  • Client SDK
    • Server flow
      • Advanced server flow
      • Session server flow
    • Web
      • Web Drop-in
      • Web Components
    • Flutter
      • Flutter Drop-in
      • Flutter Components
  • Schemas
    • Schemas
      • response.TransactionList
      • entity.SplitRequest
      • entity.PaymentBeneficiary
      • request.CreatePaymentBeneficiary
      • entity.SettlementPaymentOrder
      • entity.PayoutRequest
      • entity.PayoutRequestRowData
      • command.HandleThreeDResult
      • domain.Report
      • entity.CardSaveSessionCustomer
      • entity.Permission
      • entity.UserProfile
      • entity.UserRole
      • errors.Message
      • errors.Source
      • errors.Type
      • git_plexypay_com_ecom_back_api_internal_domain_view.Page-domain_Report
      • git_plexypay_com_ecom_back_api_internal_domain_view.Page-entity_UserProfile
      • git_plexypay_com_ecom_back_api_internal_platform_errors.Code
      • models.CSVApiRequest
      • models.CreateBussinessDetails
      • models.KeyResponse
      • models.OnboardingRequest
      • models.Transaction
      • paymentcore.Address
      • paymentcore.CustomerDetails
      • request.AuthorizePayment
      • request.BrowserDetails
      • request.CardData
      • request.ChangeUserRole
      • request.ContinueThreeDS
      • request.CreateCardSaveSession
      • request.CreateInviteSession
      • request.CreatePaymentLink
      • request.CreatePaymentLinkMetadata
      • request.HandlePayout
      • request.MerchantInitiatedPayment
      • request.PasswordRequest
      • request.Recurring
      • request.RefundPayment
      • request.SaveCard
      • request.SaveOneCustomer
      • request.TwoStepAuthorizePayment
      • request.UpdateMerchantSettingsRequest
      • request.UpdatePaymentLink
      • response.AcquirerResponseThreeDSecure
      • response.AuthorizeAndCapturePayment
      • response.AuthorizePayment
      • response.CancelPaymentResponse
      • response.CapturePaymentResponse
      • response.ContinueThreeDS
      • response.Currency
      • response.Customer
      • response.CustomerTransaction
      • response.CustomerTransactions
      • response.Customers
      • response.Error
      • response.Merchant
      • response.MerchantInitiatedPayment
      • response.MerchantSettings
      • response.PaymentLink
      • response.PaymentLinkInfo
      • response.PaymentLinkMetadata
      • response.PaymentLinksInfo
      • response.PaymentLinksStatistics
      • response.PaymentLinksStatisticsItem
      • response.Payout
      • response.Permission
      • response.RefundPaymentResponse
      • response.Report
      • response.SavedCard
      • response.Session
      • response.Settlement
      • response.SettlementTransaction
      • response.Store
      • response.Stores
      • response.Transaction
      • response.TransactionDetails
      • response.TransactionEvents
      • response.TransactionHistoryEvent
      • response.TransactionHistoryEventData
      • response.TransactionResponse
      • response.TransactionWebhookDetails
      • response.Transactions
      • response.UpdateMerchantSettingsResponse
      • response.UserProfile
      • value.PaymentMethod
    • receipt
    • Error
    • DecimalAmount
    • ProductType
    • ProductCategory
    • Product
    • Order
    • AgentBalance
    • AgentDeposit
    • TopupRequest
    • CreateOrderRequest
Pay APIGate APIDashboard
Pay APIGate APIDashboard
  1. Payments

Overview

Payment Methods#

PlexyPay provides flexible payment integration options to suit different business needs. This guide covers all available payment methods and their use cases.
INFO
Choose the integration method that best fits your technical requirements and business model. Each method offers different levels of control and complexity.

Payment Links#

Payment Links offer the simplest integration method, allowing you to collect payments without complex technical setup.

How It Works#

Payment links can be generated in two ways:
Dashboard Generation
Create links manually through your merchant dashboard
Quick setup with no coding required
Perfect for individual invoices
API Generation
Generate links programmatically using our Create Payment Link API endpoint
Automate link creation for your workflow
Integrate with your existing systems

Distribution#

Once generated, share the link with your customers through any channel:
Messaging apps (WhatsApp, Telegram, etc.)
Embedded in your website or app
When customers click the link, they're directed to our secure hosted checkout page where they can complete their payment.
Perfect For
Invoicing, one-time payments, sharing payment requests quickly without technical integration
Learn more: Payment Links Documentation

Recurring Payments#

Enable subscription-based business models with recurring payment functionality.

Overview#

Recurring payments allow you to securely store payment methods in the PlexyPay system and process automatic charges without customer interaction.
Subscription Services
Automatically charge customers on a recurring schedule
Membership Fees
Collect periodic membership or access fees
Installment Plans
Split payments into multiple scheduled charges
Auto-Renewals
Seamlessly renew subscriptions without customer action

Merchant-Initiated Payments (MIT)#

When you store a payment method, you receive a unique identifier that you keep in your system. When it's time to charge the customer (e.g., monthly subscription renewal), you can initiate the payment through our API without requiring the customer to be present.
Why Use Merchant-Initiated Payments?
Benefits:
Reduced Friction: No need for customers to re-enter payment details
Higher Conversion: Automatic renewals prevent cancellations due to payment failures
Better Cash Flow: Predictable recurring revenue
Customer Convenience: Set-it-and-forget-it payment experience
Use Cases:
SaaS platforms with monthly/annual subscriptions
Streaming services
Subscription box businesses
Membership sites and communities
Software license renewals
Learn more: Merchant-Initiated Payments Documentation
Important
Ensure you have proper customer authorization before storing payment methods and initiating recurring charges. Comply with card network rules for stored credentials.

Host-to-Host Payments#

Take full control of the payment experience with our direct API integration.

Overview#

Host-to-host integration is an API-only method where you manage the entire payment flow:
This method does not use the PlexyPay hosted checkout interface (checkout.plexypay.com). You maintain complete control over the UI/UX.

Why Choose Direct Payments?#

Complete UI Control
Design payment forms that perfectly match your brand identity and user experience standards. Implement custom validation, styling, and interactive elements.
Seamless Experience
Keep customers on your site throughout the entire payment process. Eliminate redirects and maintain consistent branding from cart to confirmation.
Custom Workflows
Implement specialized payment flows tailored to your business logic:
Multi-step checkout processes
Dynamic pricing calculations
Custom fraud prevention rules
Special promotional flows
Advanced Integration
Build sophisticated payment orchestration:
Payment method routing
A/B testing of checkout flows
Integration with internal systems
Custom analytics and tracking
Learn more: Host-to-Host Payments API Documentation
Security Requirement
Direct payment integration requires PCI DSS compliance. Ensure your infrastructure meets all security requirements for handling card data. This typically requires Level 1 or Level 2 PCI certification depending on transaction volume.

Webhooks#

Stay informed about payment status changes in real-time.
All successful payments trigger webhook notifications to your configured endpoint. Webhooks enable automated workflows and real-time system updates.

Automation Benefits#

Order Fulfillment: Automatically process and ship orders
Inventory Updates: Real-time stock management
Customer Notifications: Trigger confirmation emails
Accounting Sync: Update financial systems instantly
Learn more: Webhooks Documentation
Best Practice
Always verify webhook auth key to ensure requests are genuinely from PlexyPay.

Transaction Management#

Every payment attempt creates a transaction record in the PlexyPay system, regardless of outcome.

Payment Capturing#

Control when funds are captured from customer accounts with flexible clearing options.

Auto-Capture (Default)#

Setting: autoclear = true
By default, all payments automatically complete the capture process after authorization. This provides immediate settlement with no additional action required.
Best for:
Digital products with instant delivery
Services with no fulfillment delay
Standard e-commerce transactions
High-volume automated processing

Manual Capture#

Setting: autoclear = false
Set manual capture for greater control over the payment lifecycle. You must explicitly call the capture API to finalize the transaction.
Best for:
Physical goods requiring inventory verification
Custom orders needing approval
Fraud screening workflows
Variable pricing or adjustments
Pre-orders and delayed fulfillment

Capture Operations#

Cancel Transaction
Capture Transaction
Refund Transaction
Authorization Window
Authorization holds typically expire after 3 days for card payments. Ensure you capture transactions within this window to avoid authorization expiration.
Learn more:
Payment Management
Transaction Management

Comparison Table#

Choose the right payment method for your integration needs:
FeaturePayment LinksRecurring PaymentsHost-to-Host Payments
Integration ComplexitySimpleModerateAdvanced
Development TimeMinutesHoursDays
Custom UINoNoYes
PCI DSS RequiredNoNoYes
Customer PresentYesNoYes
Uses Hosted CheckoutYesInitial setupNo
API Calls RequiredOptionalYesYes
Best ForQuick payments, invoicesSubscriptions, recurring billingCustom experiences, white-label
Typical Use CaseOne-time invoice paymentMonthly SaaS subscriptionMarketplace checkout flow

Quick Reference#

Payment Links API
Generate payment links via API
Recurring Payments
Merchant-initiated payment guide
Host-to-Host Payments API
Host-to-host integration docs
Webhook Reference
Handle payment notifications
Transaction Management
Capture, cancel, and refund operations
API Reference
Complete API documentation
Modified at 2025-10-04 15:52:03
Previous
Ecommerce Plugins
Next
Payment Links
Built with