Paystack integration

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 this endpoint.

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.

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

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.

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 products when making a payment.

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

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.

Create bulk transfer recipient

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.

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.