Skip to main content
Payhere logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: PAYHERE
  • Version: 20261101_00

Tools

Slug: PAYHERE_CREATE_HOOKTool to subscribe to a REST hook for receiving webhook events. Use when you need to register a webhook endpoint to receive real-time notifications for payment_received, subscription_cancelled, or subscription_created events.

Input Parameters

string
required
Your platform’s endpoint URL that will receive POST requests when events trigger.
string ("payment_received" | "subscription_cancelled" | "subscription_created")
required
Event type to monitor. Must be one of: ‘payment_received’, ‘subscription_cancelled’, or ‘subscription_created’.
string
required
Friendly name of your platform. Helps with metrics and debugging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_CREATE_PLANCreate a Payhere payment plan for accepting one-off payments or recurring subscriptions. Plans can also let customers choose the payment amount, for example for donations.

Input Parameters

string
required
Display name for the plan shown to customers.
number
Plan pricing. Omit for donation plans where user_selects_amount is true.
boolean
Hide plan from landing page if true.
string
required
Three-letter currency code (e.g., ‘usd’, ‘gbp’, ‘eur’).
boolean
Enable quantity selection field. Only applies to one-off plans.
number
Initial one-time charge amount for recurring plans.
integer
Day of month for monthly charges (1-31) for recurring plans.
string
Product or service description shown to customers.
string
URL to redirect customers after successful payment.
string
Endpoint URL for receiving payment status notifications.
integer
Auto-cancel subscription after N payments for recurring plans.
string ("recurring" | "one_off")
required
Type of plan: “recurring” for subscriptions or “one_off” for one-time payments.
string
Custom message displayed on payment receipts.
string
Custom label for payment button. Defaults to “Pay”.
string ("week" | "month" | "year")
Billing frequency for recurring plans: “week”, “month”, or “year”. Required for recurring plans.
integer
Minimum billing cycles before cancellation is allowed for recurring plans.
boolean
Enable donation functionality where users choose the payment amount. When true, omit the price field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_DELETE_HOOKTool to remove a REST hook listener subscription. Use when you need to stop receiving webhook events for a specific hook.

Input Parameters

integer
required
The unique identifier of the REST hook to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_GET_CURRENT_COMPANYTool to fetch company information for the currently authenticated user. Use when you need to retrieve comprehensive company details including identity, configuration, integration status, and associated users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_GET_CURRENT_COMPANY_STATSTool to fetch payment statistics for the last 30 days with comparison data from the preceding 30-day period (30-60 days ago). Use when you need to analyze recent payment trends, subscriber growth, or compare current performance against the previous month.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_GET_USERTool to fetch information on the currently authenticated user. Use when you need to retrieve details about the logged-in user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_LIST_CUSTOMERSTool to list all customers from Payhere, ordered chronologically with most recent first. Use when you need to retrieve customer records, browse customers, or access customer information. Supports pagination via page and per_page parameters.

Input Parameters

integer
Page number for pagination. Use to navigate through paginated results.
integer
Records per page. Default is 20, maximum is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_LIST_HOOKSTool to list all active REST hooks subscriptions for the authenticated company. Use when you need to view all currently registered webhook listeners for your PayHere account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_LIST_PAYMENTSList Payhere payments in reverse chronological order to review payment history or check payment statuses. Results are paginated; choose a page and page size, up to 100 records per page.

Input Parameters

integer
Page number for pagination.
integer
Number of records per page (default: 20, maximum: 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_LIST_PLANSTool to list all plans in your PayHere account. Use when you need to retrieve and paginate through available plans.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of plans per page. Default is 20, maximum is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_LIST_SUBSCRIPTIONSTool to list all subscriptions ordered chronologically by most recent payment first. Use when you need to retrieve subscription data with customer and plan details.

Input Parameters

integer
Page number for pagination. Defaults to 1 if not specified.
integer
Number of records returned per page. Defaults to 20 if not specified. Maximum value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_UPDATE_CURRENT_COMPANYTool to update the company information for the currently authenticated user. Use when modifying company details such as name, legal name, address, logo, support email, website, or branding preferences (button color and text color).

Input Parameters

Logo image for the company.
string
Display name of the company
string
Company address for receipt display
string
Company website shown in receipts
Legal name shown on receipts
string
Text color: empty (auto), ‘white’, or ‘black’
string
Hex color for pay button (e.g., #ff6600)
string
Support email displayed in receipts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYHERE_UPDATE_PLANTool to update an existing plan’s configuration and settings. Use when you need to modify plan properties like name, description, pricing, or other settings for both one-off and subscription plans.

Input Parameters

string
required
The unique identifier of the plan to update
string
Display name for the plan
number
Plan cost (for one-off plans only)
boolean
Exclude plan from payment landing page
string
ISO 4217 currency code (for one-off plans only)
boolean
Enable quantity field on payment form (for one-off plans only)
number
Initial one-time charge (for subscription plans only)
integer
Monthly charge date (for subscription plans only)
string
Product/service description shown to customers
string
Post-payment redirect destination
string
Endpoint for payment status notifications
integer
Auto-cancel after N payments (for subscription plans only)
string
Custom message added to email receipts
string
Button label (e.g., ‘Subscribe’, ‘Donate’)
integer
Minimum payments before cancellation (for subscription plans only)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not