Paystack

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, allowi

Tool to add previously created products to a Storefront. Use when you need to associate existing products with a specific storefront.

Tool to add a split code to a virtual terminal. Use when you need to assign payment splitting configuration to a virtual terminal.

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

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 listi

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 Te

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 afte

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 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

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.

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.

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 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.

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

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 am

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 platfor

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.

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.

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 rathe

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 setting

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.

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 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 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.

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.

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.

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 t

Tool to duplicate a previously created Storefront. Use when you need to create a copy of an existing storefront with the same configuration.

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.

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

Tool to fetch the available balance on your Paystack integration. Use when you need to check account balance across different currencies.

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.

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.

Tool to get details of a customer on your integration. Use when you need to retrieve customer information using their customer code.

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.

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.

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

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.

Tool to get details of a plan on your integration. Use when you need to retrieve plan information using the plan code or ID.

Tool to get details of a product on your integration. Use when you need to retrieve product information by its ID.

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.

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.

Tool to get details of a split configuration for a transaction. Use when you need to retrieve split payment configuration information by its ID.

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.

Tool to fetch all orders in a Paystack storefront. Use when you need to retrieve order information for a specific storefront using its ID.

Tool to get details of a subaccount on your integration. Use when you need to retrieve subaccount information using the subaccount code.

Tool to get details of a subscription on your integration. Use when you need to retrieve subscription information using the subscription code.

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,

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

Tool to fetch details of a transfer recipient. Use when you need to retrieve information about an existing recipient using their recipient code.

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

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.

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.

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.

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.

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 t

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 custo

Tool to initiate a bulk charge on your integration. Use when you need to charge multiple customers at once using their authorization codes.

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.

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 res

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 in

Tool to retrieve a list of countries that Paystack currently supports. Use when you need to know which countries are available for Paystack operations.

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.

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.

Tool to list all registered Apple Pay domains on your integration. Use when you need to retrieve domains configured for Apple Pay payments.

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.

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.

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.

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.

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.

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.

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.

Tool to list settlements made to your settlement accounts. Use when you need to retrieve settlement information with optional pagination support.

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.

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.

Tool to list all products in a Paystack storefront. Use when you need to retrieve product information for a specific storefront using its ID.

Tool to list storefronts available on your integration. Use when you need to retrieve all storefronts with optional filtering by status and pagination support.

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.

Tool to list all subscriptions available on your integration. Use when you need to retrieve subscriptions, optionally filtering by plan, customer, or date range.

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 cri

Tool to list transfer recipients available on your integration. Use when you need to retrieve all recipients with optional pagination support.

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.

Tool to list virtual terminals available on your integration. Use when you need to retrieve all virtual terminals with pagination support.

Tool to pause processing of a bulk charge batch. Use when you need to temporarily stop a bulk charge batch from processing further charges.

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.

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 s

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.

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

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.

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.

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 the

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),

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.

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.

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.

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.

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.

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.

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.

Tool to update the payment session timeout on your Paystack integration. Use when you need to change the duration before a payment session expires.

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; oth

Tool to update a product on your integration. Use when you need to modify product details like name, description, price, or currency.

Tool to update a split configuration for transactions. Use when you need to modify split settings such as name, active status, or bearer type.

Tool to update the details of a previously created Storefront. Use when you need to modify storefront information such as name, description, or slug.

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

Tool to update the details of a transfer recipient. Use when you need to modify an existing recipient's name or email address.

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.

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 asyn

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.

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 usi

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.

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.