Paystack

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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 to provide payment details each time.

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary