AppPay ToolInstall

Summary

Perform payment operations with AppPay.ai, including creating payment links, creating payment services with specified title, currency, and amount, checking payment status by payment ID, and canceling pending payments by payment ID.

Inputs

• Operation Mode (required) — Select the payment operation to perform: create_payment, create_payment_service, get_payment_status, or cancel_payment.
• Tool Description — Optional textual description of what the selected tool operation does, shown to AI agents. Separate fields exist per operation mode.
• Service Title (required) — Title for the payment service, required when 'create_payment_service' operation is selected, e.g., 'AI Service' or 'Premium Plan'.
• Service Currency (required) — Currency code for the payment service, required for 'create_payment_service' operation, e.g., 'USD', 'EUR', or 'GBP'.
• Service Amount (required) — Amount for the payment service, required for 'create_payment_service' operation, e.g., '20.00'.

Output shape

a single JSON object with a human-readable text response describing the payment operation result, such as payment creation details (ID, URL, status), payment status information, or cancellation confirmation.

Input to the tool function is a string query which should include necessary information depending on the operation: for create_payment, provide amount and currency info (e.g., '20 USD'); for get_payment_status and cancel_payment, provide a payment ID. The response includes textual success or error messages. Errors include guidance to verify API credentials and input validity. No direct pagination or additional structured data is returned beyond the JSON wrapped response text.

Examples

Example 1: Create a new payment link for $20 USD

Set Operation Mode to 'create_payment', optionally fill the Tool Description, then input a string like '20 USD' to the AI tool to generate a payment link.

Example 2: Create a payment service with title 'AI Service', currency USD, and amount 20.00

Set Operation Mode to 'create_payment_service' and specify 'Service Title', 'Service Currency', and 'Service Amount'. Input may provide additional JSON or string parameters but defaults are used from the parameters.

Example 3: Check payment status for a given payment ID

Set Operation Mode to 'get_payment_status', optionally describe tool, then input a JSON string with the paymentId to receive status information.