112 available actions
What your AI agent can do in Paystack
Nigerian financial technology company that offers payment processing services to businesses in Africa. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 112 actions.
Common starting points
- Get Payment Request TotalsTool to retrieve metrics for all pending and successful payment requests.
- Fetch CustomerTool to get details of a customer on your integration.
- Create CustomerTool to create a customer on your Paystack integration.
- Create Payment PageTool to create a payment page on your Paystack integration.
- Update CustomerTool to update a customer's details on your Paystack integration.
- Update Payment PageTool to update a payment page on your Paystack integration.
Browse all 112 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 51 actions
- Check Pending ChargeTool to check the status of a pending charge transaction.
- Check Slug AvailabilityTool to check if a custom slug is available for use when creating a payment page.
- Export TransactionsTool to export transactions from Paystack for a specific timeframe.
- Fetch BalanceTool to fetch the available balance on your Paystack integration.
- Fetch balance ledgerTool to fetch all pay-ins and pay-outs that went into your Paystack balance.
- Fetch Bulk Charge BatchTool to retrieve a specific bulk charge batch by code.
- Fetch CustomerTool to get details of a customer on your integration.
- Fetch Mandate AuthorizationsTool to fetch the list of direct debit mandate authorizations associated with a customer.
- Fetch Payment PageTool to fetch details of a payment page on your Paystack integration.
- Fetch Payment Request DetailsTool to fetch details of a payment request from Paystack.
- Fetch Payment Session TimeoutTool to fetch the payment session timeout configured on your Paystack integration.
- Fetch PlanTool to get details of a plan on your integration.
- Fetch ProductTool to get details of a product on your integration.
- Fetch Product OrdersTool to fetch all orders for a particular product on your Paystack integration.
- Fetch RefundTool to get details of a refund on your integration.
- Fetch SplitTool to get details of a split configuration for a transaction.
- Fetch StorefrontTool to get the details of a previously created Storefront.
- Fetch Storefront OrdersTool to fetch all orders in a Paystack storefront.
- Fetch SubaccountTool to get details of a subaccount on your integration.
- Fetch SubscriptionTool to get details of a subscription on your integration.
- Fetch TransactionTool to get details of a transaction carried out on your integration.
- Fetch Transaction TimelineTool to fetch the timeline of a transaction showing the steps taken from initiation to completion.
- Fetch Transfer RecipientTool to fetch details of a transfer recipient.
- Fetch Virtual TerminalTool to fetch a Virtual Terminal on your Paystack integration.
- Get Payment Request TotalsTool to retrieve metrics for all pending and successful payment requests.
- Get Transaction TotalsTool to get the total amount received on your Paystack account.
- List BanksTool to get a list of all supported banks and their properties on Paystack.
- List Bulk Charge BatchesTool to list bulk charge batches created on your integration.
- List Charges in BatchTool to retrieve the charges associated with a specified bulk charge batch.
- List countriesTool to retrieve a list of countries that Paystack currently supports.
- List CustomersTool to list customers available on your integration.
- List DisputesTool to list transaction disputes filed by customers on your Paystack integration.
- List Apple Pay DomainsTool to list all registered Apple Pay domains on your integration.
- List Mandate AuthorizationsTool to get a list of all direct debit mandates on your integration.
- List OrdersTool to list orders available on your integration.
- List Payment PagesTool to list payment pages available on your Paystack integration.
- List Payment RequestsTool to list all previously created payment requests to your customers.
- List PlansTool to list all subscription plans available on your integration.
- List ProductsTool to list products available on your integration.
- List RefundsTool to list refunds available on your integration.
- List SettlementsTool to list settlements made to your settlement accounts.
- List SplitsTool to list the transaction splits available on your integration.
- List states for address verificationTool to retrieve a list of states for a country for address verification.
- List Storefront ProductsTool to list all products in a Paystack storefront.
- List StorefrontsTool to list storefronts available on your integration.
- List SubaccountsTool to list subaccounts available on your integration.
- List SubscriptionsTool to list all subscriptions available on your integration.
- List TransactionsTool to list transactions that have occurred on your integration.
- List Transfer RecipientsTool to list transfer recipients available on your integration.
- List TransfersTool to list all transfers carried out on your integration.
- List Virtual TerminalsTool to list virtual terminals available on your integration.
Create & communicateCreate records or send supported messagesView 20 actions
- Add Products to PageTool to add products to a Paystack payment page.
- Add Products to StorefrontTool to add previously created products to a Storefront.
- Add Split Code to Virtual TerminalTool to add a split code to a virtual terminal.
- Add Subaccount to SplitTool to add a subaccount to a split configuration, or update the share of an existing subaccount.
- Create ChargeTool to initiate a payment by integrating the payment channel of your choice.
- Create CustomerTool to create a customer on your Paystack integration.
- Create Payment PageTool to create a payment page on your Paystack integration.
- Create Payment RequestCreate a new payment request by issuing an invoice to a customer.
- Create PlanTool to create a plan for recurring payments on Paystack.
- Create RefundTool to initiate a refund for a previously completed transaction on Paystack.
- Create Split ConfigurationTool to create a split configuration for transaction revenue sharing.
- Create StorefrontCreate a digital storefront on Paystack to manage and display products.
- Create SubaccountTool to create a subaccount on your Paystack integration.
- Create Transfer RecipientTool to create a new recipient for transfers.
- Create Virtual TerminalCreate a Virtual Terminal on your Paystack integration to accept payments.
- Generate Update Subscription LinkTool to generate a link for updating the card on a subscription.
- Publish StorefrontTool to make a Storefront publicly available on Paystack.
- Send Payment Request NotificationTool to send an email notification to a customer for a previously created payment request.
- Send Subscription Update LinkTool to send an email to the customer with a link to update the card on their subscription.
- Submit PhoneTool to submit phone number when requested during a charge transaction.
Update & manageChange and manage existing recordsView 16 actions
- Archive Payment RequestTool to archive a payment request to clean up records.
- Assign Destination to Virtual TerminalTool to assign WhatsApp destinations to a Virtual Terminal for payment notifications.
- Disable OTP for TransfersTool to disable OTP requirement for programmatic transfers.
- Disable SubscriptionTool to disable a subscription on your Paystack integration.
- Enable OTP for TransfersTool to enable OTP requirement for transfers.
- Set Risk ActionTool to set a customer's risk action by whitelisting or blacklisting them.
- Update CustomerTool to update a customer's details on your Paystack integration.
- Update Payment PageTool to update a payment page on your Paystack integration.
- Update Payment RequestTool to update a payment request on your Paystack integration.
- Update Payment Session TimeoutTool to update the payment session timeout on your Paystack integration.
- Update PlanTool to update a plan's details on your Paystack integration.
- Update ProductTool to update a product on your integration.
- Update Split ConfigurationTool to update a split configuration for transactions.
- Update StorefrontTool to update the details of a previously created Storefront.
- Update SubaccountTool to update a subaccount's details on your Paystack integration.
- Update Transfer RecipientTool to update the details of a transfer recipient.
Remove & cancelRemove records or cancel supported workView 4 actions
- Delete ProductDelete a previously created product from Paystack by its ID.
- Delete StorefrontDelete a previously created storefront from Paystack by its ID.
- Delete Transfer RecipientTool to delete a transfer recipient by setting it to inactive status.
- Remove Subaccount from SplitTool to remove a subaccount from a split configuration.
Other actionsSpecialist and administrative actions.View 21 actions
- Bulk Create Transfer RecipientsCreate multiple transfer recipients in batches.
- Deactivate AuthorizationTool to deactivate an authorization when a card or payment method needs to be forgotten.
- Deactivate Virtual TerminalTool to deactivate a Virtual Terminal on your integration.
- Duplicate StorefrontTool to duplicate a previously created Storefront.
- Finalize Payment RequestTool to finalize the creation of a draft payment request for a customer.
- Initialize AuthorizationTool to initialize a reusable authorization for recurring transactions.
- Initialize TransactionTool to initialize a transaction from your backend.
- Initiate Bulk ChargeTool to initiate a bulk charge on your integration.
- Pause Bulk ChargeTool to pause processing of a bulk charge batch.
- Resend OTP for TransferTool to resend OTP for a transfer.
- Resolve Card BINTool to get basic information about a card BIN (Bank Identification Number).
- Resume Bulk Charge BatchTool to resume processing of a previously paused bulk charge batch.
- Trigger direct debit activation chargeTool to trigger an activation charge on an inactive direct debit mandate for a customer.
- Unassign Destination from Virtual TerminalTool to unassign WhatsApp destinations from a Virtual Terminal.
- Unregister Apple Pay DomainTool to unregister a top-level domain or subdomain previously used for Apple Pay integration.
- Validate Bank AccountTool to validate the authenticity of a customer's bank account before sending money.
- Validate CustomerTool to validate a customer's identity on your Paystack integration.
- Validate OrderTool to validate a pay for me order on Paystack.
- Verify Payment RequestTool to verify the status of a previously created payment request on Paystack.
- Verify Storefront SlugTool to verify the availability of a slug before using it for a Storefront.
- Verify TransactionTool to confirm the status of a transaction using its reference.
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect Paystack
How does the agent connect to Paystack?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in Paystack?
The page above lists the 112 actions currently available through the Paystack connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Paystack included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Paystack is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put Paystack to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.