Payhere
payhereEasy payment links for accepting online payments
Acciones disponibles (13)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create HookPAYHERE_CREATE_HOOKAcciónTool 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.
PAYHERE_CREATE_HOOKAcciónTool 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.
Parámetros de entrada
post_urlstringObligatoriouriYour platform's endpoint URL that will receive POST requests when events trigger.
resourcestringObligatorioenumEvent type to monitor. Must be one of: 'payment_received', 'subscription_cancelled', or 'subscription_created'.
payment_receivedsubscription_cancelledsubscription_createdintegrationstringObligatorioFriendly name of your platform. Helps with metrics and debugging.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create PlanPAYHERE_CREATE_PLANAcciónTool to create a new payment plan in PayHere. Use when you need to set up either a recurring subscription or one-off payment plan for accepting payments.
PAYHERE_CREATE_PLANAcciónTool to create a new payment plan in PayHere. Use when you need to set up either a recurring subscription or one-off payment plan for accepting payments.
Parámetros de entrada
namestringObligatorioDisplay name for the plan shown to customers.
pricenumberPlan pricing. Omit for donation plans where user_selects_amount is true.
hiddenbooleanHide plan from landing page if true.
currencystringObligatorioThree-letter currency code (e.g., 'usd', 'gbp', 'eur').
show_qtybooleanEnable quantity selection field. Only applies to one-off plans.
setup_feenumberInitial one-time charge amount for recurring plans.
billing_dayintegerDay of month for monthly charges (1-31) for recurring plans.
descriptionstringProduct or service description shown to customers.
success_urlstringURL to redirect customers after successful payment.
webhook_urlstringEndpoint URL for receiving payment status notifications.
cancel_afterintegerAuto-cancel subscription after N payments for recurring plans.
payment_typestringObligatorioenumType of plan: "recurring" for subscriptions or "one_off" for one-time payments.
recurringone_offreceipt_textstringCustom message displayed on payment receipts.
pay_button_textstringCustom label for payment button. Defaults to "Pay".
billing_intervalstringenumBilling frequency for recurring plans: "week", "month", or "year". Required for recurring plans.
weekmonthyearmin_billing_cyclesintegerMinimum billing cycles before cancellation is allowed for recurring plans.
user_selects_amountbooleanEnable donation functionality where users choose the payment amount. When true, omit the price field.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete HookPAYHERE_DELETE_HOOKAcciónTool to remove a REST hook listener subscription. Use when you need to stop receiving webhook events for a specific hook.
PAYHERE_DELETE_HOOKAcciónTool to remove a REST hook listener subscription. Use when you need to stop receiving webhook events for a specific hook.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the REST hook to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Current CompanyPAYHERE_GET_CURRENT_COMPANYAcciónTool 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.
PAYHERE_GET_CURRENT_COMPANYAcciónTool 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Current Company StatsPAYHERE_GET_CURRENT_COMPANY_STATSAcciónTool 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.
PAYHERE_GET_CURRENT_COMPANY_STATSAcciónTool 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get UserPAYHERE_GET_USERAcciónTool to fetch information on the currently authenticated user. Use when you need to retrieve details about the logged-in user.
PAYHERE_GET_USERAcciónTool to fetch information on the currently authenticated user. Use when you need to retrieve details about the logged-in user.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CustomersPAYHERE_LIST_CUSTOMERSAcciónTool 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.
PAYHERE_LIST_CUSTOMERSAcciónTool 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.
Parámetros de entrada
pageintegerPage number for pagination. Use to navigate through paginated results.
per_pageintegerRecords per page. Default is 20, maximum is 100.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List REST HooksPAYHERE_LIST_HOOKSAcciónTool 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.
PAYHERE_LIST_HOOKSAcciónTool 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PaymentsPAYHERE_LIST_PAYMENTSAcciónTool to list all payments ordered chronologically, most recent first. Use when you need to retrieve payment history or check payment statuses. Supports pagination with page and per_page parameters.
PAYHERE_LIST_PAYMENTSAcciónTool to list all payments ordered chronologically, most recent first. Use when you need to retrieve payment history or check payment statuses. Supports pagination with page and per_page parameters.
Parámetros de entrada
pageintegerPage number for pagination.
per_pageintegerNumber of records per page (default: 20, maximum: 100).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PlansPAYHERE_LIST_PLANSAcciónTool to list all plans in your PayHere account. Use when you need to retrieve and paginate through available plans.
PAYHERE_LIST_PLANSAcciónTool to list all plans in your PayHere account. Use when you need to retrieve and paginate through available plans.
Parámetros de entrada
pageintegerPage number for pagination. Must be >= 1.
per_pageintegerNumber of plans per page. Default is 20, maximum is 100.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List subscriptionsPAYHERE_LIST_SUBSCRIPTIONSAcciónTool to list all subscriptions ordered chronologically by most recent payment first. Use when you need to retrieve subscription data with customer and plan details.
PAYHERE_LIST_SUBSCRIPTIONSAcciónTool to list all subscriptions ordered chronologically by most recent payment first. Use when you need to retrieve subscription data with customer and plan details.
Parámetros de entrada
pageintegerPage number for pagination. Defaults to 1 if not specified.
per_pageintegerNumber of records returned per page. Defaults to 20 if not specified. Maximum value is 100.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Current CompanyPAYHERE_UPDATE_CURRENT_COMPANYAcciónTool 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).
PAYHERE_UPDATE_CURRENT_COMPANYAcciónTool 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).
Parámetros de entrada
logoobjectLogo image for the company. FileUploadable object where 'name' is the filename, e.g., 'logo.png'.
namestringDisplay name of the company
addressstringCompany address for receipt display
websitestringCompany website shown in receipts
legal_namestringLegal name shown on receipts
button_textstringText color: empty (auto), 'white', or 'black'
button_colorstringHex color for pay button (e.g., #ff6600)
support_emailstringSupport email displayed in receipts
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update PlanPAYHERE_UPDATE_PLANAcciónTool 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.
PAYHERE_UPDATE_PLANAcciónTool 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.
Parámetros de entrada
idstringObligatorioThe unique identifier of the plan to update
namestringDisplay name for the plan
pricenumberPlan cost (for one-off plans only)
hiddenbooleanExclude plan from payment landing page
currencystringISO 4217 currency code (for one-off plans only)
show_qtybooleanEnable quantity field on payment form (for one-off plans only)
setup_feenumberInitial one-time charge (for subscription plans only)
billing_dayintegerMonthly charge date (for subscription plans only)
descriptionstringProduct/service description shown to customers
success_urlstringPost-payment redirect destination
webhook_urlstringEndpoint for payment status notifications
cancel_afterintegerAuto-cancel after N payments (for subscription plans only)
receipt_textstringCustom message added to email receipts
pay_button_textstringButton label (e.g., 'Subscribe', 'Donate')
min_billing_cyclesintegerMinimum payments before cancellation (for subscription plans only)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not