Reference

Add Products to Page

Tool to add products to a Paystack payment page.

Add Products to Storefront

Associates previously created products with a specific storefront, making them available for display and purchase in that storefront

Add Split Code to Virtual Terminal

Assigns a pre-configured payment split arrangement to a virtual terminal, enabling automatic distribution of incoming payments among multiple parties.

Add Subaccount to Split

Add a new subaccount to an existing payment split or update the share of an already added subaccount, enabling flexible distribution of funds among multiple parties.

Archive Payment Request

Tool to archive a payment request to clean up records.

Assign Destination to Virtual Terminal

Links a notification destination, like a WhatsApp number, to a Virtual Terminal so that payment alerts are sent to that recipient whenever a transaction occurs through the terminal.

Bulk Create Transfer Recipients

Creates multiple transfer recipients in a single batch, automatically deduplicating by returning existing records for duplicate account numbers, enabling efficient setup of payout destinations for solopreneurs managing multiple payees.

Check Pending Charge

Tool to check the status of a pending charge transaction.

Check Slug Availability

Verify if a desired custom URL slug is available for a new payment page, preventing conflicts and ensuring a unique checkout link before creation.

Create Charge

Tool to initiate a payment by integrating the payment channel of your choice.

Create Customer

Tool to create a customer on your Paystack integration.

Create Payment Page

Creates a hosted payment page that customers can visit to complete purchases, subscriptions, or donations, enabling solopreneurs to accept payments without building a custom checkout flow.

Create Payment Request

Create a new payment request by issuing an invoice to a customer.

Create Plan

Creates a recurring payment plan on Paystack with a specified amount, interval, and billing settings, enabling automated subscription charges for customers.

Create Refund

Processes refunds for completed transactions, either fully or partially, to handle customer returns or payment reversals.

Create Split Configuration

Creates a revenue-sharing rule that automatically divides incoming payments between multiple subaccounts, enabling commission distribution, marketplace payouts, or partner splits.

Create Storefront

Create a digital storefront on Paystack to manage and display products.

Create Subaccount

Creates a new subaccount within your Paystack integration, enabling you to receive payments on behalf of another party or split transaction proceeds automatically.

Create Transfer Recipient

Registers a bank account or mobile money wallet as a transfer recipient, enabling you to send payments to them later.

Create Virtual Terminal

Sets up a new virtual payment terminal to accept card payments from customers, with customizable notifications for transaction confirmations.

Deactivate Authorization

Tool to deactivate an authorization when a card or payment method needs to be forgotten.

Deactivate Virtual Terminal

Disables a virtual payment terminal to prevent it from processing any further transactions. Helps you manage which terminals are active in your business workflows.

Delete Product

Permanently removes a product from your Paystack catalog, ensuring it no longer appears for purchase.

Delete Storefront

Permanently removes a storefront from your Paystack account by its ID, freeing up resources and simplifying your operational setup.

Delete Transfer Recipient

Removes a transfer recipient from your active list, preventing future payments to that recipient. Useful for cleaning up outdated or incorrect recipient records.

Disable OTP for Transfers

Tool to disable OTP requirement for programmatic transfers.

Disable Subscription

Stops recurring charges for a customer's subscription, allowing you to manage cancellations or service terminations directly from your business tools.

Duplicate Storefront

Tool to duplicate a previously created Storefront.

Enable OTP for Transfers

Tool to enable OTP requirement for transfers.

Export Transactions

Generates a downloadable file of all transactions within a selected date range, making it easy to pull transaction records for reporting, reconciliation, or analysis.

Fetch Balance

Tool to fetch the available balance on your Paystack integration.

Fetch balance ledger

Tool to fetch all pay-ins and pay-outs that went into your Paystack balance.

Fetch Bulk Charge Batch

Tool to retrieve a specific bulk charge batch by code.

Fetch Customer

Retrieves detailed information about a specific customer using their unique customer code, enabling you to verify customer identity, check payment history, or update customer records.

Fetch Mandate Authorizations

Tool to fetch the list of direct debit mandate authorizations associated with a customer.

Fetch Payment Page

Tool to fetch details of a payment page on your Paystack integration.

Fetch Payment Request Details

Tool to fetch details of a payment request from Paystack.

Fetch Payment Session Timeout

Tool to fetch the payment session timeout configured on your Paystack integration.

Fetch Plan

Retrieves detailed information about a specific subscription plan using its unique code or ID, allowing you to view pricing, intervals, and other plan settings.

Fetch Product

Retrieve detailed information about a specific product in your Paystack inventory using its unique ID, enabling you to verify, display, or sync product data across your business workflows.

Fetch Product Orders

Tool to fetch all orders for a particular product on your Paystack integration.

Fetch Refund

Tool to get details of a refund on your integration.

Fetch Split

Tool to get details of a split configuration for a transaction.

Fetch Storefront

Retrieves detailed information about a specific storefront, including its products, contacts, and configuration settings. Use this to review or verify the setup of an online storefront created via Paystack.

Fetch Storefront Orders

Tool to fetch all orders in a Paystack storefront.

Fetch Subaccount

Retrieves detailed information about a specific subaccount on your Paystack integration, useful for verifying settings or managing payments to partners.

Fetch Subscription

Retrieves comprehensive details of a specific subscription using its unique code, enabling you to quickly check status, plan, billing history, and next payment schedule.

Fetch Transaction

Retrieves comprehensive details for a specific payment transaction, including its status, customer information, and authorization data.

Fetch Transaction Timeline

Retrieve the chronological sequence of events for a payment transaction to identify where customers encountered problems or delays

Fetch Transfer Recipient

Tool to fetch details of a transfer recipient.

Fetch Virtual Terminal

Tool to fetch a Virtual Terminal on your Paystack integration.

Finalize Payment Request

Tool to finalize the creation of a draft payment request for a customer.

Generate Update Subscription Link

Creates a secure, one-time link that customers can use to update their payment card for an active subscription, without needing to cancel or restart the subscription.

Get Payment Request Totals

Retrieves aggregated totals of all payment requests, grouped by currency and status, to help you quickly assess outstanding and completed payments.

Get Transaction Totals

Tool to get the total amount received on your Paystack account.

Initialize Authorization

Sets up a reusable payment authorization that allows you to charge a customer's account on a recurring basis without needing them to re-enter payment details each time

Initialize Transaction

Starts a payment session and generates a secure checkout link that customers can use to complete their payment.

Initiate Bulk Charge

Tool to initiate a bulk charge on your integration.

List Apple Pay Domains

Retrieves all domains registered for Apple Pay on your integration, allowing you to verify and manage which websites can accept Apple Pay payments.

List Banks

Tool to get a list of all supported banks and their properties on Paystack.

List Bulk Charge Batches

Tool to list bulk charge batches created on your integration.

List Charges in Batch

Retrieves the individual charges processed within a specific bulk charge batch, allowing you to review each charge's status, amount, and other details for reconciliation or monitoring.

List countries

Retrieves the list of countries where Paystack operates, enabling you to tailor your payment flows and business operations to supported regions.

List Customers

Retrieves a list of all customers associated with your Paystack integration, with optional date filtering and pagination to manage large datasets efficiently.

List Disputes

Tool to list transaction disputes filed by customers on your Paystack integration.

List Mandate Authorizations

Retrieves a list of all direct debit mandate authorizations on your integration, allowing you to filter by status and paginate results for easy management of recurring payment agreements.

List Orders

Retrieves a paginated list of all orders from your Paystack integration, with optional filtering by date range for easy review and analysis.

List Payment Pages

Fetch all payment pages linked to your Paystack account, with optional filtering by creation date and pagination for easy browsing.

List Payment Requests

Tool to list all previously created payment requests to your customers.

List Plans

Tool to list all subscription plans available on your integration.

List Products

Retrieves a list of all products created on your Paystack account, with options to filter by status, date range, or paginate results. Use this to manage and review your product catalog.

List Refunds

Tool to list refunds available on your integration.

List Settlements

Tool to list settlements made to your settlement accounts.

List Splits

Retrieve all transaction split configurations from your integration, with the ability to filter 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.

List Storefront Products

Tool to list all products in a Paystack storefront.

List Storefronts

Retrieves all storefronts linked to your account, with options to filter by status and control pagination for efficient browsing.

List Subaccounts

Retrieves all subaccounts linked to your Paystack integration, with optional filtering by active status and pagination support for managing payment splits.

List Subscriptions

Tool to list all subscriptions available on your integration.

List Transactions

Fetches a detailed history of all payments and transactions on your account, with filters to narrow down by date, status, customer, or payment method. Use this to track earnings, reconcile accounts, or analyze payment activity.

List Transfer Recipients

Retrieves a paginated list of all transfer recipients in your Paystack account, enabling you to view and manage who can receive payouts.

List Transfers

Tool to list all transfers carried out on your integration.

List Virtual Terminals

Fetches all virtual terminals linked to your account, enabling you to view and manage your in-person payment devices.

Pause Bulk Charge

Tool to pause processing of a bulk charge batch.

Publish Storefront

Tool to make a Storefront publicly available on Paystack.

Remove Subaccount from Split

Tool to remove a subaccount from a split configuration.

Resend OTP for Transfer

Tool to resend OTP for a transfer.

Resolve Card BIN

Tool to get basic information about a card BIN (Bank Identification Number).

Resume Bulk Charge Batch

Restarts processing of a previously paused bulk charge batch, allowing you to continue charging customers without re-creating the batch.

Send Payment Request Notification

Tool to send an email notification to a customer for a previously created payment request.

Send Subscription Update Link

Tool to send an email to the customer with a link to update the card on their subscription.

Set Risk Action

Tool to set a customer's risk action by whitelisting or blacklisting them.

Submit Phone

Tool to submit phone number when requested during a charge transaction.

Trigger direct debit activation charge

Tool to trigger an activation charge on an inactive direct debit mandate for a customer.

Unassign Destination from Virtual Terminal

Tool to unassign WhatsApp destinations from a Virtual Terminal.

Unregister Apple Pay Domain

Tool to unregister a top-level domain or subdomain previously used for Apple Pay integration.

Update Customer

Tool to update a customer's details on your Paystack integration.

Update Payment Page

Modify an existing payment page’s details such as name, description, amount, or active status to keep your checkout pages up-to-date with your business needs.

Update Payment Request

Modify details of an existing payment request—such as amount, due date, description, or metadata—without creating a new one, helping you manage billing adjustments efficiently.

Update Payment Session Timeout

Tool to update the payment session timeout on your Paystack integration.

Update Plan

Modifies an existing subscription plan's name, amount, interval, or other details while preserving all other settings. Ideal for evolving your pricing or plan structure without disrupting active subscriptions.

Update Product

Modifies existing product details such as name, description, price, or currency to keep your catalog accurate and up to date.

Update Split Configuration

Tool to update a split configuration for transactions.

Update Storefront

Modifies the name, description, or slug of an existing storefront to keep your online store aligned with current branding, marketing, or operational needs.

Update Subaccount

Modify an existing subaccount's details, such as business name, bank account, or contact information, to keep your payment records accurate and up to date.

Update Transfer Recipient

Tool to update the details of a transfer recipient.

Validate Bank Account

Verifies that a bank account number and bank code combination is valid and active for receiving funds, helping prevent failed transfers and fraud.

Validate Customer

Tool to validate a customer's identity on your Paystack integration.

Validate Order

Tool to validate a pay for me order on Paystack.

Verify Payment Request

Checks the current status and details of a payment request, allowing you to confirm whether it has been paid or is still pending.

Verify Storefront Slug

Checks whether a custom URL slug is available for a new Paystack Storefront, helping you avoid conflicts before creating it.

Verify Transaction

Tool to confirm the status of a transaction using its reference.