Connect Claude & ChatGPT to Stax

129 tools for Stax

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

• attach_user_to_merchantChanges dataAttach a user (user id). API summary: Link Existing User to Merchant.
• cancel_paymentDeletesVoid a payment (transaction id). Destructive action; may require approval. API summary: Void Transaction.
• cancel_payment_or_refundMoves moneyVoid a payment (transaction id). Financial or irreversible action; may require approval. API summary: Void or Refund Transaction.
• cancel_terminalDeletesVoid a terminal. Destructive action; may require approval.
• cancel_terminal_or_refundMoves moneyVoid a terminal. Financial or irreversible action; may require approval. API summary: Void/Refund.
• create_a_card_payment_methodChanges dataCreate a new payment method. Required: customer id, method, person name, card number, card cvv or card exp. API summary: Create a Card Payment Method.
• create_accountChanges dataCreate a new account. Required: bank account number or bank routing number. Search accounts first to avoid duplicates. API summary: Create a Funding Account.
• create_account_documentChanges dataCreate a new document for a account. API summary: Add Supporting File to Funding Account.
• create_brandingChanges dataCreate a new branding. API summary: Team Branding.
• create_catalog_itemChanges dataCreate a catalog item with its name in `item`, plus optional `price`, `code`, `quantity`, description and tax or service flags.
• create_creditChanges dataCreate a new credit. Required: total or payment method id. API summary: Credit A Payment Method.
• create_credit_creditChanges dataCreate a new credit. Required: total or register.
• create_customerChanges dataCreate a customer with first and last name, email, phone, company, address and internal notes. At least a name, email or company is needed; search first to avoid duplicates.
• create_documentChanges dataCreate a new document. Required: name or file. API summary: Add File to Merchant Registration.
• create_forgotDeletesCreate a new forgot. Required: email or url. Destructive action; may require approval. API summary: Initiate Password Reset.
• create_invoiceChanges dataCreate an invoice for a customer with `customer_id`, `total` and optional line items, tax and memo in `meta`; leave `url` at its default Stax bill-pay page. This does not send it.
• create_merchantChanges dataCreate a new merchant. API summary: Create a Merchant.
• create_merchant_apikeyChanges dataCreate a new apikey for a merchant. API summary: Create a New API Key for Merchant.
• create_payment_linkChanges dataCreate a shareable payment link with a `common_name`, the `url` where your payment page is hosted, and an optional fixed `amount` (0 lets the payer enter it).
• create_payment_methodChanges dataCreate a new payment method. Required: customer id, method, person name, bank account, bank routing or bank name. API summary: Create a Bank Payment Method.
• create_payment_method_external_vaultChanges dataCreate a new external vault for a payment method. API summary: Share a payment method with a third party.
• create_printChanges dataCreate a new print. Required: message or register.
• create_prompt_choiceChanges dataCreate a new prompt choice. Required: register or choices.
• create_prompt_inputChanges dataCreate a new prompt input. Required: register. API summary: Prompt (Input).
• create_scheduleChanges dataCreate a new schedule. API summary: Create a Scheduled Invoice.
• create_selfChanges dataCreate a new self. Required: email or name. API summary: Create a User Account - Self Registration.
• create_signatureChanges dataCreate a new signature. Required: register. API summary: Prompt (Signature).
• create_teamChanges dataCreate a new team. Required: company name or contact email. API summary: Create a Team.
• create_tokenizeChanges dataCreate a new tokenize. Required: customer id, register or tokenize.
• create_userChanges dataCreate a new user. Required: email or name. Search users first to avoid duplicates. API summary: Create a New Team Member.
• create_verifyChanges dataCreate a new verify. Required: total or payment method id. API summary: Verify A Payment Method.
• create_webhookDeletesCreate a new webhook. Destructive action; may require approval. API summary: Create a Webhook for All User's Merchants.
• delete_brandDeletesPermanently delete a brand by webhook id. Destructive action; may require approval. API summary: Delete a Partner Level Webhook for your brand.
• delete_customerDeletesPermanently delete a customer by customer id. Destructive action; may require approval.
• delete_disputeDeletesPermanently delete a dispute by evidence file id. Destructive action; may require approval. API summary: Delete Evidence for Dispute.
• delete_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete File from Merchant Registration.
• delete_invoiceDeletesDelete an invoice by `invoice_id`. This cannot be undone.
• delete_payment_linkDeletesPermanently delete a payment link by payment link id. Destructive action; may require approval.
• delete_payment_methodDeletesPermanently delete a payment method by payment method id. Destructive action; may require approval.
• delete_productDeletesPermanently delete a product by product id. Destructive action; may require approval. API summary: Delete a Catalog Item.
• delete_scheduleDeletesPermanently delete a schedule by schedule id. Destructive action; may require approval. API summary: Delete an Invoice Schedule.
• delete_webhookDeletesPermanently delete a webhook by webhook id. Destructive action; may require approval.
• detach_user_to_merchantDeletesDetach a user (user id). Destructive action; may require approval. API summary: Unlink User from Merchant.
• get_accountGet one account by account id. API summary: Get a Funding Account's Information.
• get_brandGet one brand by webhook id. API summary: Get a specific Partner Level Webhook for your brand.
• get_catalog_itemGet one catalog item by `product_id`, with price and stock.
• get_current_userGet the signed-in Stax user and their merchant team (company name, contact details). Use to confirm which account you are working in.
• get_customerGet one customer by `customer_id`, including contact details, address and notes.
• get_disputeGet one dispute by merchant id. Results are paginated. API summary: List Disputes for a Merchant.
• get_invoiceGet one invoice by `invoice_id`, with total, status, customer and payment details.
• get_merchantGet one merchant by merchant id. API summary: Get Merchant by ID.
• get_payment_linkGet one payment link by `payment_link_id`, including amount and whether it is active.
• get_payment_methodGet one payment method by payment method id. API summary: Get a Payment Method By ID.
• get_terminal_statusGet one status for a terminal by transaction id. API summary: Get Transaction Status.
• get_terms_and_conditionGet one terms and condition by terms and condition id. API summary: Retrieve Terms and Conditions.
• get_transactionGet one transaction by `payment_id`, with amount, status, payment method and customer.
• get_userGet one user by user id. API summary: Get Team Member's Information.
• list_ach_rejectsList ach rejects. Optional filters: start date or end date. API summary: ACH Rejections.
• list_apikeysList apikeys. API summary: List API Keys.
• list_brandsList brands. API summary: Get all Partner Level Webhooks for your brand.
• list_card_processingsList card processings. Optional filters: start date or end date.
• list_card_typesList card types. Optional filters: start date or end date. API summary: Volumes by card type.
• list_codesList codes. API summary: Retrieve All Item Codes.
• list_customer_payment_methodsList a customer's saved cards and bank accounts by `customer_id` (masked details only).
• list_daily_salesGet daily sales totals between `start_date` and `end_date` (YYYY-MM-DD).
• list_deposit_detailsList deposit details. Optional filters: start date, end date, batch id, timezone or time zone offset. API summary: Get Details of Specific Deposit.
• list_depositsList bank deposits (payouts) between `start_date` and `end_date` (YYYY-MM-DD HH:mm:ss).
• list_disputesList chargeback disputes, filtered by `status`, `reason`, `transaction_id` or date range.
• list_disputes_disputesList disputes. Optional filters: start date or end date.
• list_documentsList documents. Optional filters: user id, subject, type, is enabled, fill missing or group by. API summary: Get Registration Documents.
• list_ephemeralsList ephemerals. Optional filters: user id or user email. API summary: Ephemeral Authentication Tokens.
• list_feesList fees. Optional filters: start date or end date.
• list_invoice_schedulesList scheduled (recurring) invoices, optionally for one `customer_id`, sorted by next or last run date.
• list_merchant_apikeysList apikeys for a merchant. API summary: List API Keys for Merchant.
• list_merchant_registrationsList registrations for a merchant. API summary: Get Merchant Registration Data.
• list_merchantsList merchants. Optional filters: statuses, reference, risk hold, ids, contact email or contact phone. Results are paginated. API summary: Get all Merchants.
• list_payment_fundingsList fundings for a payment. API summary: Get a Transaction's Funding Instructions.
• list_payment_link_is_activesList is actives for a payment link. API summary: Get A Payment Link's Active Status.
• list_payment_methodsList payment methods. Optional filters: au last event, au last event start at, au last event end at or status. Results are paginated. API summary: Get all Payment Methods for a Merchant.
• list_payment_relatedList related for a payment. API summary: Get a Related Transaction.
• list_registersList registers. API summary: Get all devices.
• list_registrationsList registrations. API summary: Get Team Registration Data.
• list_reviewsList reviews. Optional filters: payment method id or total. API summary: Review a Transaction's Surcharge Information.
• list_surchargesList surcharges. Optional filters: start date or end date. API summary: Surcharging.
• list_team_summariesList team summaries. API summary: Team Summary.
• list_webhooksList webhooks. Results are paginated. API summary: Get All Webhooks.
• pay_invoiceMoves moneyPay a invoice (invoice id). Financial or irreversible action; may require approval. API summary: Pay an Invoice.
• pay_paymentMoves moneyPay a payment. Financial or irreversible action; may require approval. API summary: Charge a Payment Method.
• pay_payment_captureMoves moneyCapture a payment (transactionid). Financial or irreversible action; may require approval. API summary: Capture a Pre-Auth Transaction.
• pay_queueMoves moneyPay a queue. Financial or irreversible action; may require approval. API summary: Charge (Queue).
• pay_terminalMoves moneyCharge a terminal. Financial or irreversible action; may require approval.
• refund_adjustmentMoves moneyRefund a adjustment. Financial or irreversible action; may require approval. API summary: Refund and Adjustments.
• refund_terminalMoves moneyRefund a terminal. Financial or irreversible action; may require approval.
• refund_transactionMoves moneyRefund a settled transaction by `transaction_id` for the given `total`. Money is returned to the customer and this cannot be undone.
• restore_rootVisible to othersRestore a root (customer id). Has effects visible outside this system. API summary: Unarchive a Deleted/ Archived Customer.
• search_accountsSearch accounts by bank name, status, flags, active, keywords or sort. Use this to find existing accounts before creating a new account. API summary: List and Filter All Funding Accounts.
• search_catalog_itemsList catalog items, filtered by `name`, `code`, `price`, `is_active`, `is_service` or `is_taxable`.
• search_customersFind customers by `firstname`, `lastname`, `email`, `company`, `phone` or free-text `keywords`. Use this to find a customer's ID before other lookups.
• search_existsSearch exists by email. Use this to find existing exists before creating a new exist. API summary: Check if E-Mail Exists.
• search_invoicesFind invoices by `keywords`, customer `name`, `email`, `company_name`, `schedule_id` or invoice `id`. Use to find unpaid or recent invoices.
• search_payment_linksList payment links, filtered by `active` or `keywords` (name, amount).
• search_transactionsList and filter transactions (payments) by `customer_id`, date range, `type` (charge, refund, void and more), `keywords`, amount or success.
• search_usersSearch users. Use this to find existing users before creating a new user. API summary: Find the Merchant Team's Users.
• send_invoice_emailDeletesEmail an invoice to its customer by `invoice_id`, optionally copying extra addresses in `cc_emails`. The email is sent immediately.
• send_receipt_emailDeletesEmail the receipt for a transaction by `transaction_id`, optionally to extra addresses in `cc_emails`. The email is sent immediately.
• send_smsDeletesSend a sms (invoice id). Destructive action; may require approval. API summary: Send an Invoice via SMS.
• submit_disputeVisible to othersSubmit a dispute (dispute id). Has effects visible outside this system. API summary: Submit Dispute Evidence Files for Review.
• submit_verifyDeletesResend a verify. Destructive action; may require approval. API summary: Resend Verification E-Mail.
• update_accountChanges dataUpdate an existing account identified by account id. API summary: Update a Funding Account.
• update_advanced_customizationsVisible to othersUpdate an existing advanced customization. Has effects visible outside this system.
• update_catalog_itemChanges dataUpdate a catalog item's name, price, code, category, stock or flags by `product_id`. Only the fields you pass change.
• update_customerChanges dataUpdate a customer's name, email, phone, company, address or notes by `customer_id`. Only the fields you pass change.
• update_invoiceChanges dataUpdate an existing invoice identified by invoice id. API summary: Update an Invoice.
• update_invoice_payMoves moneyUpdate an existing pay identified by method. Financial or irreversible action; may require approval. API summary: Mark an Invoice Paid in Cash or Check.
• update_merchant_registrationsVisible to othersUpdate an existing registration identified by merchant id. Has effects visible outside this system. API summary: Update Merchant Registration Data.
• update_optionsVisible to othersUpdate an existing option. Has effects visible outside this system. API summary: Add/Update Team Settings.
• update_paymentChanges dataUpdate an existing payment identified by payment id. API summary: Update a Transaction.
• update_payment_linkChanges dataUpdate or deactivate a payment link by `payment_link_id` (set `active` false to switch it off); `url` and `common_name` are required.
• update_payment_link_statsChanges dataUpdate an existing payment link identified by payment link id. API summary: Update A Payment Link's Stats.
• update_payment_methodChanges dataUpdate an existing payment method identified by payment method id. API summary: Update a Payment Method.
• update_payment_receipt_smsDeletesUpdate an existing receipt sms identified by transaction id. Destructive action; may require approval. API summary: SMS Transaction Receipt.
• update_product_decrementsVisible to othersUpdate an existing decrement identified by item id. Has effects visible outside this system. API summary: Decrement Item's Stock.
• update_product_incrementsVisible to othersUpdate an existing increment identified by item id. Has effects visible outside this system. API summary: Increment Item's Stock.
• update_registrationsVisible to othersUpdate an existing registration. Has effects visible outside this system. API summary: Update Team Registration Data.
• update_scheduleChanges dataUpdate an existing schedule identified by schedule id. API summary: Edit an Invoice Schedule.
• update_selvesVisible to othersUpdate an existing self. Has effects visible outside this system. API summary: Update Your User Info.
• update_teamsVisible to othersUpdate an existing team. Has effects visible outside this system. API summary: Edit Your Merchant Team's Info.
• update_userChanges dataUpdate an existing user identified by user id. API summary: Update Team Member's Information.
• upload_disputeChanges dataUpload a dispute. API summary: Upload Evidence for Dispute.

Questions