NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Payhere

payhere

Easy payment links for accepting online payments

EcommercePayment ProcessingWeb del proveedor
Acciones
13
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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_urlstringObligatoriouri

    Your platform's endpoint URL that will receive POST requests when events trigger.

  • resourcestringObligatorioenum

    Event type to monitor. Must be one of: 'payment_received', 'subscription_cancelled', or 'subscription_created'.

    payment_receivedsubscription_cancelledsubscription_created
  • integrationstringObligatorio

    Friendly name of your platform. Helps with metrics and debugging.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create PlanPAYHERE_CREATE_PLANAcción

Tool 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

  • namestringObligatorio

    Display name for the plan shown to customers.

  • pricenumber

    Plan pricing. Omit for donation plans where user_selects_amount is true.

  • hiddenboolean

    Hide plan from landing page if true.

  • currencystringObligatorio

    Three-letter currency code (e.g., 'usd', 'gbp', 'eur').

  • show_qtyboolean

    Enable quantity selection field. Only applies to one-off plans.

  • setup_feenumber

    Initial one-time charge amount for recurring plans.

  • billing_dayinteger

    Day of month for monthly charges (1-31) for recurring plans.

  • descriptionstring

    Product or service description shown to customers.

  • success_urlstring

    URL to redirect customers after successful payment.

  • webhook_urlstring

    Endpoint URL for receiving payment status notifications.

  • cancel_afterinteger

    Auto-cancel subscription after N payments for recurring plans.

  • payment_typestringObligatorioenum

    Type of plan: "recurring" for subscriptions or "one_off" for one-time payments.

    recurringone_off
  • receipt_textstring

    Custom message displayed on payment receipts.

  • pay_button_textstring

    Custom label for payment button. Defaults to "Pay".

  • billing_intervalstringenum

    Billing frequency for recurring plans: "week", "month", or "year". Required for recurring plans.

    weekmonthyear
  • min_billing_cyclesinteger

    Minimum billing cycles before cancellation is allowed for recurring plans.

  • user_selects_amountboolean

    Enable donation functionality where users choose the payment amount. When true, omit the price field.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete HookPAYHERE_DELETE_HOOKAcción

Tool to remove a REST hook listener subscription. Use when you need to stop receiving webhook events for a specific hook.

Parámetros de entrada

  • idintegerObligatorio

    The unique identifier of the REST hook to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Current CompanyPAYHERE_GET_CURRENT_COMPANYAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Current Company StatsPAYHERE_GET_CURRENT_COMPANY_STATSAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get UserPAYHERE_GET_USERAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List CustomersPAYHERE_LIST_CUSTOMERSAcción

Tool 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

  • pageinteger

    Page number for pagination. Use to navigate through paginated results.

  • per_pageinteger

    Records per page. Default is 20, maximum is 100.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List REST HooksPAYHERE_LIST_HOOKSAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List PaymentsPAYHERE_LIST_PAYMENTSAcción

Tool 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

  • pageinteger

    Page number for pagination.

  • per_pageinteger

    Number of records per page (default: 20, maximum: 100).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List PlansPAYHERE_LIST_PLANSAcción

Tool to list all plans in your PayHere account. Use when you need to retrieve and paginate through available plans.

Parámetros de entrada

  • pageinteger

    Page number for pagination. Must be >= 1.

  • per_pageinteger

    Number of plans per page. Default is 20, maximum is 100.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List subscriptionsPAYHERE_LIST_SUBSCRIPTIONSAcción

Tool 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

  • pageinteger

    Page number for pagination. Defaults to 1 if not specified.

  • per_pageinteger

    Number of records returned per page. Defaults to 20 if not specified. Maximum value is 100.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Current CompanyPAYHERE_UPDATE_CURRENT_COMPANYAcción

Tool 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

  • logoobject

    Logo image for the company. FileUploadable object where 'name' is the filename, e.g., 'logo.png'.

  • namestring

    Display name of the company

  • addressstring

    Company address for receipt display

  • websitestring

    Company website shown in receipts

  • legal_namestring

    Legal name shown on receipts

  • button_textstring

    Text color: empty (auto), 'white', or 'black'

  • button_colorstring

    Hex color for pay button (e.g., #ff6600)

  • support_emailstring

    Support email displayed in receipts

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update PlanPAYHERE_UPDATE_PLANAcción

Tool 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

  • idstringObligatorio

    The unique identifier of the plan to update

  • namestring

    Display name for the plan

  • pricenumber

    Plan cost (for one-off plans only)

  • hiddenboolean

    Exclude plan from payment landing page

  • currencystring

    ISO 4217 currency code (for one-off plans only)

  • show_qtyboolean

    Enable quantity field on payment form (for one-off plans only)

  • setup_feenumber

    Initial one-time charge (for subscription plans only)

  • billing_dayinteger

    Monthly charge date (for subscription plans only)

  • descriptionstring

    Product/service description shown to customers

  • success_urlstring

    Post-payment redirect destination

  • webhook_urlstring

    Endpoint for payment status notifications

  • cancel_afterinteger

    Auto-cancel after N payments (for subscription plans only)

  • receipt_textstring

    Custom message added to email receipts

  • pay_button_textstring

    Button label (e.g., 'Subscribe', 'Donate')

  • min_billing_cyclesinteger

    Minimum payments before cancellation (for subscription plans only)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not