- Category: payment processing
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 112
- Triggers: 0
- Slug:
PAYSTACK - Version: 20261101_00
Tools
Add Products to Page
Add Products to Page
PAYSTACK_ADD_PRODUCTS_TO_PAGETool 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.Input Parameters
Output
Add Products to Storefront
Add Products to Storefront
Add Split Code to Virtual Terminal
Add Split Code to Virtual Terminal
Add Subaccount to Split
Add Subaccount to Split
PAYSTACK_ADD_SUBACCOUNT_TO_SPLITTool 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.Input Parameters
Output
Archive Payment Request
Archive Payment Request
PAYSTACK_ARCHIVE_PAYMENT_REQUESTTool 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.Input Parameters
Output
Assign Destination to Virtual Terminal
Assign Destination to Virtual Terminal
PAYSTACK_ASSIGN_DESTINATION_TO_VIRTUAL_TERMINALTool 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.Input Parameters
Output
Check Pending Charge
Check Pending Charge
PAYSTACK_CHECK_PENDING_CHARGETool 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.Input Parameters
Output
Check Slug Availability
Check Slug Availability
Bulk Create Transfer Recipients
Bulk Create Transfer Recipients
PAYSTACK_CREATE_BULK_TRANSFER_RECIPIENTCreate 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.Input Parameters
Output
Create Charge
Create Charge
PAYSTACK_CREATE_CHARGETool 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.Input Parameters
Output
Create Customer
Create Customer
Create Payment Page
Create Payment Page
PAYSTACK_CREATE_PAYMENT_PAGETool 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.Input Parameters
Output
Create Payment Request
Create Payment Request
PAYSTACK_CREATE_PAYMENT_REQUESTCreate 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.Input Parameters
Output
Create Plan
Create Plan
PAYSTACK_CREATE_PLANTool 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.Input Parameters
Output
Create Refund
Create Refund
PAYSTACK_CREATE_REFUNDTool 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.Input Parameters
Output
Create Split Configuration
Create Split Configuration
PAYSTACK_CREATE_SPLITTool 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).Input Parameters
Output
Create Storefront
Create Storefront
PAYSTACK_CREATE_STOREFRONTCreate 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.Input Parameters
Output
Create Subaccount
Create Subaccount
Create Transfer Recipient
Create Transfer Recipient
PAYSTACK_CREATE_TRANSFER_RECIPIENTTool 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.Input Parameters
Output
Create Virtual Terminal
Create Virtual Terminal
PAYSTACK_CREATE_VIRTUAL_TERMINALCreate 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.Input Parameters
Output
Deactivate Virtual Terminal
Deactivate Virtual Terminal
PAYSTACK_DEACTIVATE_VIRTUAL_TERMINALTool to deactivate a Virtual Terminal on your integration. Use when you need to disable a terminal and prevent it from accepting further payments.Input Parameters
Output
Delete Product
Delete Product
PAYSTACK_DELETE_PRODUCTDelete 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.Input Parameters
Output
Delete Storefront
Delete Storefront
PAYSTACK_DELETE_STOREFRONTDelete 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.Input Parameters
Output
Delete Transfer Recipient
Delete Transfer Recipient
PAYSTACK_DELETE_TRANSFER_RECIPIENTTool to delete a transfer recipient by setting it to inactive status. Use when you need to remove a recipient from the active transfer list.Input Parameters
Output
Disable OTP for Transfers
Disable OTP for Transfers
Disable Subscription
Disable Subscription
Duplicate Storefront
Duplicate Storefront
Enable OTP for Transfers
Enable OTP for Transfers
Export Transactions
Export Transactions
PAYSTACK_EXPORT_TRANSACTIONSTool 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.Input Parameters
Output
Fetch Balance
Fetch Balance
Fetch balance ledger
Fetch balance ledger
PAYSTACK_FETCH_BALANCE_LEDGERTool 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.Input Parameters
Output
Fetch Bulk Charge Batch
Fetch Bulk Charge Batch
Fetch Customer
Fetch Customer
Fetch Payment Page
Fetch Payment Page
Fetch Payment Request Details
Fetch Payment Request Details
Fetch Payment Session Timeout
Fetch Payment Session Timeout
Fetch Plan
Fetch Plan
Fetch Product
Fetch Product
Fetch Product Orders
Fetch Product Orders
Fetch Refund
Fetch Refund
Fetch Split
Fetch Split
Fetch Storefront
Fetch Storefront
Fetch Storefront Orders
Fetch Storefront Orders
Fetch Subaccount
Fetch Subaccount
Fetch Subscription
Fetch Subscription
Fetch Transaction
Fetch Transaction
Fetch Transaction Timeline
Fetch Transaction Timeline
Fetch Transfer Recipient
Fetch Transfer Recipient
PAYSTACK_FETCH_TRANSFER_RECIPIENTTool to fetch details of a transfer recipient. Use when you need to retrieve information about an existing recipient using their recipient code.Input Parameters
Output
Fetch Virtual Terminal
Fetch Virtual Terminal
Finalize Payment Request
Finalize Payment Request
Generate Update Subscription Link
Generate Update Subscription Link
Get Payment Request Totals
Get Payment Request Totals
Get Transaction Totals
Get Transaction Totals
PAYSTACK_GET_TRANSACTION_TOTALSTool 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.Input Parameters
Output
Initialize Transaction
Initialize Transaction
PAYSTACK_INITIALIZE_TRANSACTIONTool 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.Input Parameters
Output
Initiate Bulk Charge
Initiate Bulk Charge
PAYSTACK_INITIATE_BULK_CHARGETool to initiate a bulk charge on your integration. Use when you need to charge multiple customers at once using their authorization codes.Input Parameters
Output
List Banks
List Banks
PAYSTACK_LIST_BANKSTool 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.Input Parameters
Output
List Bulk Charge Batches
List Bulk Charge Batches
List Charges in Batch
List Charges in Batch
PAYSTACK_LIST_CHARGES_IN_BATCHTool 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.Input Parameters
Output
List countries
List countries
List Customers
List Customers
PAYSTACK_LIST_CUSTOMERSTool to list customers available on your integration. Use when you need to retrieve all customers with optional filtering by date range and pagination support.Input Parameters
Output
List Disputes
List Disputes
List Apple Pay Domains
List Apple Pay Domains
PAYSTACK_LIST_DOMAINSTool to list all registered Apple Pay domains on your integration. Use when you need to retrieve domains configured for Apple Pay payments.Input Parameters
Output
List Orders
List Orders
List Payment Pages
List Payment Pages
List Payment Requests
List Payment Requests
PAYSTACK_LIST_PAYMENT_REQUESTSTool 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.Input Parameters
Output
List Plans
List Plans
List Products
List Products
List Refunds
List Refunds
List Settlements
List Settlements
List Splits
List Splits
List states for address verification
List states for address verification
List Storefront Products
List Storefront Products
List Storefronts
List Storefronts
List Subaccounts
List Subaccounts
List Subscriptions
List Subscriptions
PAYSTACK_LIST_SUBSCRIPTIONSTool to list all subscriptions available on your integration. Use when you need to retrieve subscriptions, optionally filtering by plan, customer, or date range.Input Parameters
Output
List Transactions
List Transactions
PAYSTACK_LIST_TRANSACTIONSList transactions on your integration with optional filters including date range, status, source, channel and customer. Supports cursor-based and page-based pagination to retrieve transactions in batches.Input Parameters
Output
List Transfer Recipients
List Transfer Recipients
PAYSTACK_LIST_TRANSFER_RECIPIENTSTool to list transfer recipients available on your integration. Use when you need to retrieve all recipients with optional pagination support.Input Parameters
Output
List Transfers
List Transfers
PAYSTACK_LIST_TRANSFERSTool 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.Input Parameters
Output
List Virtual Terminals
List Virtual Terminals
Pause Bulk Charge
Pause Bulk Charge
Publish Storefront
Publish Storefront
PAYSTACK_PUBLISH_STOREFRONTTool 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.Input Parameters
Output
Remove Subaccount from Split
Remove Subaccount from Split
PAYSTACK_REMOVE_SUBACCOUNT_FROM_SPLITTool 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 current allocation.Input Parameters
Output
Resend OTP for Transfer
Resend OTP for Transfer
PAYSTACK_RESEND_OTP_FOR_TRANSFERTool 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.Input Parameters
Output
Resolve Card BIN
Resolve Card BIN
Resume Bulk Charge Batch
Resume Bulk Charge Batch
Send Payment Request Notification
Send Payment Request Notification
PAYSTACK_SEND_PAYMENT_REQUEST_NOTIFICATIONTool 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.Input Parameters
Output
Send Subscription Update Link
Send Subscription Update Link
PAYSTACK_SEND_SUBSCRIPTION_UPDATE_LINKTool 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.Input Parameters
Output
Set Risk Action
Set Risk Action
PAYSTACK_SET_RISK_ACTIONTool 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’ (blacklist), or ‘default’ (no special action).Input Parameters
Output
Submit Phone
Submit Phone
Trigger direct debit activation charge
Trigger direct debit activation charge
PAYSTACK_TRIGGER_DIRECT_DEBIT_ACTIVATION_CHARGETool to trigger an activation charge on an inactive direct debit mandate for a customer. Use when a mandate needs to be reactivated or retried.Input Parameters
Output
Unassign Destination from Virtual Terminal
Unassign Destination from Virtual Terminal
PAYSTACK_UNASSIGN_DESTINATION_FROM_VIRTUAL_TERMINALTool 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.Input Parameters
Output
Unregister Apple Pay Domain
Unregister Apple Pay Domain
PAYSTACK_UNREGISTER_APPLE_PAY_DOMAINTool 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.Input Parameters
Output
Update Customer
Update Customer
Update Payment Page
Update Payment Page
PAYSTACK_UPDATE_PAYMENT_PAGETool 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.Input Parameters
Output
Update Payment Request
Update Payment Request
PAYSTACK_UPDATE_PAYMENT_REQUESTTool 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.Input Parameters
Output
Update Payment Session Timeout
Update Payment Session Timeout
PAYSTACK_UPDATE_PAYMENT_SESSION_TIMEOUTTool to update the payment session timeout on your Paystack integration. Use when you need to change the duration before a payment session expires.Input Parameters
Output
Update Plan
Update Plan
PAYSTACK_UPDATE_PLANTool 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 unchanged.Input Parameters
Output
Update Product
Update Product
PAYSTACK_UPDATE_PRODUCTTool to update a product on your integration. Use when you need to modify product details like name, description, price, or currency.Input Parameters
Output
Update Split Configuration
Update Split Configuration
PAYSTACK_UPDATE_SPLITTool to update a split configuration for transactions. Use when you need to modify split settings such as name, active status, or bearer type.Input Parameters
Output
Update Storefront
Update Storefront
PAYSTACK_UPDATE_STOREFRONTTool to update the details of a previously created Storefront. Use when you need to modify storefront information such as name, description, or slug.Input Parameters
Output
Update Subaccount
Update Subaccount
PAYSTACK_UPDATE_SUBACCOUNTTool 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.Input Parameters
Output
Update Transfer Recipient
Update Transfer Recipient
PAYSTACK_UPDATE_TRANSFER_RECIPIENTTool to update the details of a transfer recipient. Use when you need to modify an existing recipient’s name or email address.Input Parameters
Output
Validate Bank Account
Validate Bank Account
PAYSTACK_VALIDATE_BANK_ACCOUNTTool 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.Input Parameters
Output
Validate Customer
Validate Customer
PAYSTACK_VALIDATE_CUSTOMERTool 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 Paystack sends a webhook event when verification is complete.Input Parameters
Output
Validate Order
Validate Order
Verify Payment Request
Verify Payment Request
PAYSTACK_VERIFY_PAYMENT_REQUESTTool 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.Input Parameters
Output
Verify Storefront Slug
Verify Storefront Slug
PAYSTACK_VERIFY_STOREFRONT_SLUGCheck whether a storefront slug is available before creating a storefront. The result identifies the slug as available or taken and may include existing storefront details when it is taken.