Paystack

Tools

• 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 select from multiple pro

• 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 allocation. The split

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

• 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 charge before calling thi

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

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

• 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 sharing, or commission distr

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

• 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

  destructive

  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

  destructive

  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

  destructive

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

• 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 associated metadata.

• 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 info, and timestamps.

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

Works well with

How Switchy teams use it

Starter prompts

@Paystack create a payment link for $150 with description 'Website redesign deposit' and send me the URL

@Paystack check the status of transaction reference TRX_abc123xyz and tell me if it's successful

@Paystack add product IDs prod_001 and prod_002 to storefront store_main

@Paystack add subaccount sub_partner01 to split code SPL_xyz with 25% share

@Paystack create transfer recipients for these accounts: John Doe 0123456789 GTBank, Jane Smith 9876543210 Access Bank

Example outputs

Illustrative - representative of the model's voice and quality, not literal recordings.

Use-case deep-dives

Frequently asked