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, allowing customers to select from multiple products when making a payment.

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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 allocation. The split must already exist before adding subaccounts to it.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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 charge before calling this endpoint.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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 sharing, or commission distribution).

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

Tool to deactivate a Virtual Terminal on your integration. Use when you need to disable a terminal and prevent it from accepting further payments.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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 a certain time.

Untrusted display-only summary