NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

BTCPay Server

btcpay_server

BTCPay Server is a free, open-source, self-hosted Bitcoin payment processor that enables merchants to accept Bitcoin payments without intermediaries.

Payment ProcessingEcommerceWeb del proveedor
Acciones
17
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 (17)

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

Tool to create a new payment request for a store. use after confirming store id.

Parámetros de entrada

  • emailstringemail

    Customer email address for notifications

  • titlestringObligatorio

    Title of the payment request

  • amountnumberObligatorio

    Requested amount, must be non-negative

  • storeIdstringObligatorio

    BTCPay Server store ID where the payment request will be created

  • currencystringObligatorio

    Three-letter currency code (e.g., USD, EUR)

  • metadataobject

    Arbitrary metadata to attach to this payment request

  • expiryDatestringdate-time

    Expiration date in ISO 8601 format

  • descriptionstring

    Optional description for the customer

  • redirectUrlstringuri

    URL to redirect the customer after payment

  • customAmountboolean

    Allow customer to enter a custom amount

  • notificationUrlstringuri

    Webhook URL for payment notifications

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

Tool to create a new store in btcpay server. use when you need to provision a new store before processing transactions.

Parámetros de entrada

  • namestringObligatorio

    The name of the store to be created.

  • websitestring

    Optional: The public website URL of the store.

  • defaultCurrencystring

    Optional: ISO currency code (e.g., 'USD', 'BTC') to use as default for invoices.

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 BTCPay Server UserBTCPAY_SERVER_CREATE_USERAcción

Tool to create a new btcpay server user. use when you need to register a new user programmatically as an administrator.

Parámetros de entrada

  • emailstringObligatorioemail

    The email address of the new user

  • passwordstringObligatorio

    Password for the new user, minimum 8 characters

  • isAdministratorboolean

    Indicates if the new user should have administrative privileges. Defaults to false

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

Register a WebhookBTCPAY_SERVER_CREATE_WEBHOOKAcción

Tool to register a new webhook. use when you need to receive store event notifications.

Parámetros de entrada

  • urlstringObligatorio

    The callback URL to receive webhook POST payloads

  • secretstring

    HMAC secret used to sign webhook deliveries. If omitted, the server generates one.

  • enabledboolean

    Whether the webhook is active

  • storeIdstringObligatorio

    The identifier of the store to register the webhook for

  • authorizedEventsobjectObligatorio

    Events to subscribe to via this webhook

  • automaticRedeliveryboolean

    Automatically retry failed deliveries

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

Tool to revoke a specific api key. use when you need to remove an api key to immediately prevent its use. call after identifying the key to revoke.

Parámetros de entrada

  • apikeystringObligatorio

    The API key string to revoke. Must match an existing API key for the authenticated user.

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

Tool to delete a specific payment request. use when you need to archive/remove an existing payment request for a store.

Parámetros de entrada

  • storeIdstringObligatorio

    ID of the store

  • paymentRequestIdstringObligatorio

    ID of the payment request 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

Delete Store PayoutBTCPAY_SERVER_DELETE_PAYOUTAcción

Tool to delete a specific payout from a store. use when you need to cancel a payout no longer needed.

Parámetros de entrada

  • storeIdstringObligatorio

    ID of the store containing the payout

  • payoutIdstringObligatorio

    ID of the payout 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 API KeyBTCPAY_SERVER_GET_API_KEYAcción

Tool to retrieve the current api key. use after authentication to get api key details.

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

Tool to list api keys. use when you need to retrieve all api keys associated with the authenticated 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

Get Payment RequestsBTCPAY_SERVER_GET_PAYMENT_REQUESTSAcción

Tool to list all payment requests for a specific store. use after confirming you have the store id.

Parámetros de entrada

  • store_idstringObligatorio

    Identifier of the store whose payment requests will be listed.

Parámetros de salida

  • dataobject[]Obligatorio

    Array of payment requests returned by the API.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get BTCPay Server InfoBTCPAY_SERVER_GET_SERVER_INFOAcción

Tool to retrieve information about the btcpay server instance. use when needing server version, tor address, supported payment methods, and synchronization states.

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

Tool to retrieve information about a specific store. use when you need full store configuration.

Parámetros de entrada

  • store_idstringObligatorio

    The identifier of the store to retrieve information for.

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 BTCPay Server UserBTCPAY_SERVER_GET_USERAcción

Tool to retrieve information about a specific user. use when you need to fetch profile data for a given user id or email.

Parámetros de entrada

  • id_or_emailstringObligatorio

    The ID or email of the user to retrieve

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

Tool to retrieve details of a specific webhook. use when you need to verify the configuration or status of a webhook for a given store after its creation.

Parámetros de entrada

  • storeIdstringObligatorio

    Identifier of the store containing the webhook

  • webhookIdstringObligatorio

    Identifier of the webhook to retrieve

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

Tool to list all webhooks registered for a store. use when you need to retrieve the configured webhooks for management or auditing.

Parámetros de entrada

  • storeIdstringObligatorio

    Identifier of the store to fetch webhooks for

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

Tool to list all apps associated with a specific store. use when retrieving basic metadata of every app in that store.

Parámetros de entrada

  • storeIdstringObligatorio

    The identifier of the store to list apps for.

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 BTCPay Server UserBTCPAY_SERVER_UPDATE_USERAcción

Tool to update current user information. use when you need to modify your authenticated user profile on btcpay server.

Parámetros de entrada

  • namestring

    New display name for the user

  • emailstringemail

    New email address for the user

  • imageUrlstring

    New profile picture URL for the user

  • newPasswordstring

    New password for the user (min length 8)

  • currentPasswordstring

    Current password (required when changing password)

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