Team
Shared credential for production and unattended runs.
Connect Paystack with Hookshot™ and your stack
Nigerian financial technology company that offers payment processing services to businesses in Africa.
Tools and triggers
What Agents can do in Paystack
Available tools and events after Paystack is connected.
-
Add Products to Page
Tool to add products to a Paystack payment page. Use when you need to add products to an existing page that was created with 'product' type. This action adds the specified products to the page, allowing customers to…
-
Add Products to Storefront
Tool to add previously created products to a Storefront. Use when you need to associate existing products with a specific storefront.
-
Add Split Code to Virtual Terminal
Tool to add a split code to a virtual terminal. Use when you need to assign payment splitting configuration to a virtual terminal.
-
Add Subaccount to Split
Tool to add a subaccount to a split configuration, or update the share of an existing subaccount. Use this when you need to modify the payment distribution by adding new partners/customers to a split or adjusting their…
-
Archive Payment Request
Tool to archive a payment request to clean up records. Use when you need to remove a payment request from active listings. An archived payment request cannot be verified and will not appear when listing payment requests.
-
Assign Destination to Virtual Terminal
Tool to assign WhatsApp destinations to a Virtual Terminal for payment notifications. Use when you need to add recipients who will receive notifications for payments made through a specific Virtual Terminal.
-
Bulk Create Transfer Recipients
Create multiple transfer recipients in batches. Use when you need to add multiple recipients at once for transfers. Duplicate account numbers automatically return existing recipient records instead of creating…
-
Check Pending Charge
Tool to check the status of a pending charge transaction. Use when you receive a 'pending' status from a charge endpoint or need to verify if a charge status has changed. Wait at least 10 seconds after initiating a…
-
Check Slug Availability
Tool to check if a custom slug is available for use when creating a payment page. Use when you need to verify a slug is not already taken before creating a new payment page.
-
Create Charge
Tool to initiate a payment by integrating the payment channel of your choice. Use when you need to charge a customer using authorization code, bank account, mobile money, or USSD.
-
Create Customer
Tool to create a customer on your Paystack integration. Use when you need to add a new customer with their email address and optional details like name and phone number.
-
Create Payment Page
Tool to create a payment page on your Paystack integration. Use when you need to create a payment page that customers can visit to make payments.
-
Create Payment Request
Create a new payment request by issuing an invoice to a customer. Use this when you need to request payment from a customer for goods or services.
-
Create Plan
Tool to create a plan for recurring payments on Paystack. Use when you need to set up subscription billing or recurring payment schedules. The plan defines the amount, interval, and other settings for recurring charges…
-
Create Refund
Tool to initiate a refund for a previously completed transaction on Paystack. Use when a customer requests a refund or when you need to reverse a payment. The refund can be for the full transaction amount or a partial…
-
Create Split Configuration
Tool to create a split configuration for transaction revenue sharing. Use when you need to configure how transaction revenue should be split between multiple subaccounts (e.g., for marketplace platforms, revenue…
-
Create Storefront
Create a digital storefront on Paystack to manage and display products. Use this when you need to set up a new online shop for selling digital or physical products.
-
Create Subaccount
Tool to create a subaccount on your Paystack integration. Use when you need to set up a new subaccount with bank details and settlement information.
-
Create Transfer Recipient
Tool to create a new recipient for transfers. Use when you need to set up a recipient before initiating a transfer. Note: A duplicate account number will lead to retrieval of the existing record rather than creating a…
-
Create Virtual Terminal
Create a Virtual Terminal on your Paystack integration to accept payments. Use this when you need to set up a new payment terminal for in-person or remote transactions with custom notification settings.
-
Deactivate Authorization
Tool to deactivate an authorization when a card or payment method needs to be forgotten. Use when customers want to remove saved payment methods from their account.
-
Deactivate Virtual Terminal
Tool to deactivate a Virtual Terminal on your integration. Use when you need to disable a terminal and prevent it from accepting further payments.
-
Delete Product
Delete a previously created product from Paystack by its ID. Use this when you need to remove a product from your catalog. The deletion is permanent and cannot be undone.
-
Delete Storefront
Delete a previously created storefront from Paystack by its ID. Use this when you need to remove a storefront. The deletion is permanent and cannot be undone.
-
Delete Transfer Recipient
Tool to delete a transfer recipient by setting it to inactive status. Use when you need to remove a recipient from the active transfer list.
-
Disable OTP for Transfers
Tool to disable OTP requirement for programmatic transfers. Use when you want to complete transfers without OTP verification. Returns an OTP needed to finalize the request.
-
Disable Subscription
Tool to disable a subscription on your Paystack integration. Use when you need to stop recurring charges for a customer subscription. Requires the subscription code and email verification token sent to the customer.
-
Duplicate Storefront
Tool to duplicate a previously created Storefront. Use when you need to create a copy of an existing storefront with the same configuration.
-
Enable OTP for Transfers
Tool to enable OTP requirement for transfers. Use when a customer wants to stop being able to complete transfers programmatically and require OTP verification instead.
-
Export Transactions
Tool to export transactions from Paystack for a specific timeframe. Use when you need to download transaction data for reporting, analysis, or record-keeping purposes. The API returns a download link that expires after…
-
Fetch Balance
Tool to fetch the available balance on your Paystack integration. Use when you need to check account balance across different currencies.
-
Fetch Balance Ledger
Tool to fetch all pay-ins and pay-outs that went into your Paystack balance. Use when you need to view transaction history and balance changes over time.
-
Fetch Bulk Charge Batch
Tool to retrieve a specific bulk charge batch by code. Use when you need to check the progress of a bulk charge batch via its total_charges and pending_charges attributes.
-
Fetch Customer
Tool to get details of a customer on your integration. Use when you need to retrieve customer information using their customer code.
-
Fetch Mandate Authorizations
Tool to fetch the list of direct debit mandate authorizations associated with a customer. Use when you need to retrieve all mandate authorizations for a specific customer ID.
-
Fetch Payment Page
Tool to fetch details of a payment page on your Paystack integration. Use when you need to retrieve information about a specific payment page by its ID.
-
Fetch Payment Request Details
Tool to fetch details of a payment request from Paystack. Use when you need to retrieve comprehensive information about a previously created payment request, including customer details, payment status, line items, and…
-
Fetch Payment Session Timeout
Tool to fetch the payment session timeout configured on your Paystack integration. Use when you need to check the current timeout duration for payment sessions.
-
Fetch Plan
Tool to get details of a plan on your integration. Use when you need to retrieve plan information using the plan code or ID.
-
Fetch Product
Tool to get details of a product on your integration. Use when you need to retrieve product information by its ID.
-
Fetch Product Orders
Tool to fetch all orders for a particular product on your Paystack integration. Use when you need to retrieve order history and details for a specific product by its ID.
-
Fetch Refund
Tool to get details of a refund on your integration. Use when you need to retrieve comprehensive information about a specific refund, including status, amount, customer details, and timestamps.
-
Fetch Split
Tool to get details of a split configuration for a transaction. Use when you need to retrieve split payment configuration information by its ID.
-
Fetch Storefront
Tool to get the details of a previously created Storefront. Use when you need to retrieve information about a specific storefront including its products, contacts, and configuration.
-
Fetch Storefront Orders
Tool to fetch all orders in a Paystack storefront. Use when you need to retrieve order information for a specific storefront using its ID.
-
Fetch Subaccount
Tool to get details of a subaccount on your integration. Use when you need to retrieve subaccount information using the subaccount code.
-
Fetch Subscription
Tool to get details of a subscription on your integration. Use when you need to retrieve subscription information using the subscription code.
-
Fetch Transaction
Tool to get details of a transaction carried out on your integration. Use when you need to retrieve comprehensive information about a specific transaction, including payment status, customer details, authorization…
-
Fetch Transaction Timeline
Tool to fetch the timeline of a transaction showing the steps taken from initiation to completion. Use when you need to debug payment flows or understand where customers encountered issues during the payment process.
-
Fetch Transfer Recipient
Tool to fetch details of a transfer recipient. Use when you need to retrieve information about an existing recipient using their recipient code.
-
Fetch Virtual Terminal
Tool to fetch a Virtual Terminal on your Paystack integration. Use when you need to retrieve details about an existing virtual terminal, including its configuration, payment methods, and active status.
-
Finalize Payment Request
Tool to finalize the creation of a draft payment request for a customer. Use when you need to convert a draft payment request into an active one that can be paid by the customer.
-
Generate Update Subscription Link
Tool to generate a link for updating the card on a subscription. Use when you need to allow a customer to update their payment card for an active subscription.
-
Get Payment Request Totals
Tool to retrieve metrics for all pending and successful payment requests. Use when you need an overview of payment request amounts grouped by currency and status.
-
Get Transaction Totals
Tool to get the total amount received on your Paystack account. Use when you need to retrieve transaction totals and pending transfers, optionally filtered by date range.
-
Initialize Authorization
Tool to initialize a reusable authorization for recurring transactions. Use when you need to create a direct debit mandate that allows charging a customer's account repeatedly without requiring them to provide payment…
-
Initialize Transaction
Tool to initialize a transaction from your backend. Returns an authorization URL to redirect the customer to for payment. Use when you need to start a payment flow and get a checkout URL for the customer.
-
Initiate Bulk Charge
Tool to initiate a bulk charge on your integration. Use when you need to charge multiple customers at once using their authorization codes.
-
List Apple Pay Domains
Tool to list all registered Apple Pay domains on your integration. Use when you need to retrieve domains configured for Apple Pay payments.
-
List Banks
Tool to get a list of all supported banks and their properties on Paystack. Use when you need to retrieve available banks for payments, transfers, or account verification.
-
List Bulk Charge Batches
Tool to list bulk charge batches created on your integration. Use when you need to view all bulk charge batches, optionally filtering by status (active, paused, or complete) and paginating through results.
-
List Charges in Batch
Tool to retrieve the charges associated with a specified bulk charge batch. Use when you need to inspect individual charge details within a batch to monitor charge statuses or retrieve charge-level information.
-
List Countries
Tool to retrieve a list of countries that Paystack currently supports. Use when you need to know which countries are available for Paystack operations.
-
List Customers
Tool to list customers available on your integration. Use when you need to retrieve all customers with optional filtering by date range and pagination support.
-
List Disputes
Tool to list transaction disputes filed by customers on your Paystack integration. Use when you need to retrieve disputes with optional filtering by status, transaction, or date range.
-
List Mandate Authorizations
Tool to get a list of all direct debit mandates on your integration. Use when you need to retrieve mandate authorizations with optional filtering by status and pagination support.
-
List Orders
Tool to list orders available on your integration. Use when you need to retrieve all orders with optional filtering by date range and pagination support.
-
List Payment Pages
Tool to list payment pages available on your Paystack integration. Use when you need to retrieve all payment pages with optional filtering by date range and pagination.
-
List Payment Requests
Tool to list all previously created payment requests to your customers. Use when you need to retrieve a list of payment requests with optional filters for customer, status, currency, or date range.
-
List Plans
Tool to list all subscription plans available on your integration. Use when you need to retrieve plans, optionally filtering by interval, amount, or date range.
-
List Products
Tool to list products available on your integration. Use when you need to retrieve all products with optional filtering by date range, active status, and pagination support.
-
List Refunds
Tool to list refunds available on your integration. Use when you need to retrieve a list of refunds with optional filters for date range and pagination.
-
List Settlements
Tool to list settlements made to your settlement accounts. Use when you need to retrieve settlement information with optional pagination support.
-
List Splits
Tool to list the transaction splits available on your integration. Use when you need to retrieve all split configurations with optional filtering by name, status, subaccount, or date range.
-
List States for Address Verification
Tool to retrieve a list of states for a country for address verification. Use when you need to get available states/provinces for a specific country code.
-
List Storefront Products
Tool to list all products in a Paystack storefront. Use when you need to retrieve product information for a specific storefront using its ID.
-
List Storefronts
Tool to list storefronts available on your integration. Use when you need to retrieve all storefronts with optional filtering by status and pagination support.
-
List Subaccounts
Tool to list subaccounts available on your integration. Use when you need to retrieve all subaccounts with optional filtering by active status and pagination support.
-
List Subscriptions
Tool to list all subscriptions available on your integration. Use when you need to retrieve subscriptions, optionally filtering by plan, customer, or date range.
-
List Transactions
Tool to list transactions that have occurred on your integration. Use when you need to retrieve all transactions with optional filtering by date range, status, source, channel, customer, and other criteria. Supports…
-
List Transfer Recipients
Tool to list transfer recipients available on your integration. Use when you need to retrieve all recipients with optional pagination support.
-
List Transfers
Tool to list all transfers carried out on your integration. Use when you need to retrieve transfer history with optional filtering by status, recipient, or date range.
-
List Virtual Terminals
Tool to list virtual terminals available on your integration. Use when you need to retrieve all virtual terminals with pagination support.
-
Pause Bulk Charge
Tool to pause processing of a bulk charge batch. Use when you need to temporarily stop a bulk charge batch from processing further charges.
-
Publish Storefront
Tool to make a Storefront publicly available on Paystack. Use this when you need to publish a previously created storefront so that customers can access and purchase from it.
-
Remove Subaccount From Split
Tool to remove a subaccount from a split configuration. Use this when you need to stop payment distribution to a specific partner or customer in an existing split. The share parameter must match the subaccount's…
-
Resend OTP for Transfer
Tool to resend OTP for a transfer. Use when a customer is having trouble receiving their OTP and needs a new one sent to complete their transfer.
-
Resolve Card BIN
Tool to get basic information about a card BIN (Bank Identification Number). Use when you need to retrieve card details such as brand, issuing bank, country, and card type from the first 6 digits of a card.
-
Resume Bulk Charge Batch
Tool to resume processing of a previously paused bulk charge batch. Use when you need to restart a paused bulk charge batch using its batch code.
-
Send Payment Request Notification
Tool to send an email notification to a customer for a previously created payment request. Use when you need to remind a customer about an unpaid invoice or payment request.
-
Send Subscription Update Link
Tool to send an email to the customer with a link to update the card on their subscription. Use when a customer needs to update their payment card for an active subscription and you want to notify them via email.
-
Set Risk Action
Tool to set a customer's risk action by whitelisting or blacklisting them. Use when you need to apply fraud prevention rules to a specific customer by setting their risk action to 'allow' (whitelist), 'deny'…
-
Submit Phone
Tool to submit phone number when requested during a charge transaction. Use this when a charge requires phone number submission for verification or authentication purposes.
-
Trigger Direct Debit Activation Charge
Tool to trigger an activation charge on an inactive direct debit mandate for a customer. Use when a mandate needs to be reactivated or retried.
-
Unassign Destination From Virtual Terminal
Tool to unassign WhatsApp destinations from a Virtual Terminal. Use when you need to remove recipients who should no longer receive payment notifications for a specific Virtual Terminal.
-
Unregister Apple Pay Domain
Tool to unregister a top-level domain or subdomain previously used for Apple Pay integration. Use when you need to remove a domain from your Apple Pay configuration.
-
Update Customer
Tool to update a customer's details on your Paystack integration. Use when you need to modify existing customer information such as name, phone number, or metadata.
-
Update Payment Page
Tool to update a payment page on your Paystack integration. Use when you need to modify details of an existing payment page such as name, description, amount, or active status.
-
Update Payment Request
Tool to update a payment request on your Paystack integration. Use when you need to modify details of an existing payment request such as amount, description, due date, or other attributes.
-
Update Payment Session Timeout
Tool to update the payment session timeout on your Paystack integration. Use when you need to change the duration before a payment session expires.
-
Update Plan
Tool to update a plan's details on your Paystack integration. Use when you need to modify an existing plan's name, amount, interval, or other settings. Only the fields you provide will be updated; other fields remain…
-
Update Product
Tool to update a product on your integration. Use when you need to modify product details like name, description, price, or currency.
-
Update Split Configuration
Tool to update a split configuration for transactions. Use when you need to modify split settings such as name, active status, or bearer type.
-
Update Storefront
Tool to update the details of a previously created Storefront. Use when you need to modify storefront information such as name, description, or slug.
-
Update Subaccount
Tool to update a subaccount's details on your Paystack integration. Use when you need to modify existing subaccount information such as business name, bank details, contact information, or activation status.
-
Update Transfer Recipient
Tool to update the details of a transfer recipient. Use when you need to modify an existing recipient's name or email address.
-
Validate Bank Account
Tool to validate the authenticity of a customer's bank account before sending money. Use when you need to confirm account details are correct and the account is active and can receive funds.
-
Validate Customer
Tool to validate a customer's identity on your Paystack integration. Use when you need to verify customer identification details such as BVN and bank account information. The verification happens asynchronously, and…
-
Validate Order
Tool to validate a pay for me order on Paystack. Use when you need to verify the details and status of a previously created order using its unique order code.
-
Verify Payment Request
Tool to verify the status of a previously created payment request on Paystack. Use when you need to check if a payment request has been paid or to retrieve details about a specific payment request using its request code.
-
Verify Storefront Slug
Tool to verify the availability of a slug before using it for a Storefront. Use when you need to check if a slug is available before creating a new storefront.
-
Verify Transaction
Tool to confirm the status of a transaction using its reference. Use when you need to verify a payment was successful or check the current state of a transaction after customer completes checkout.
Setup
Connect Paystack in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
