list_dedicated_virtual_accounts
List Dedicated Virtual Accounts
Retrieve a list of dedicated virtual accounts on your integration. Filter by active status, currency, provider, or customer.
list_dedicated_virtual_accounts
Retrieve a list of dedicated virtual accounts on your integration. Filter by active status, currency, provider, or customer.
update_plan
Update an existing subscription plan. Modify the name, amount, interval, description, and notification settings.
create_refund
Create a refund for a completed transaction. You can refund the full amount or a partial amount. Refunds go through statuses: pending, processing, processed, success/failed.
resolve_dispute
Resolve a transaction dispute by providing evidence or accepting the dispute with a refund.
list_plans
Retrieve a paginated list of subscription plans on your integration. Filter by status, interval, or amount.
list_customers
Retrieve a paginated list of customers on your integration. Supports filtering by date range.
charge_authorization
Charge a customer's saved payment authorization from a previous successful transaction. Useful for recurring payments, one-click checkout, and billing customers without redirecting them. Amounts are in the **smallest currency unit**.
list_disputes
Retrieve a paginated list of transaction disputes. Filter by status, transaction, or date range.
list_payment_pages
Retrieve a paginated list of payment pages on your integration.
list_subaccounts
Retrieve a paginated list of subaccounts on your integration.
list_banks
Retrieve the list of supported banks and their codes. Use this to find the bank code needed for verifying accounts and creating transfer recipients.
get_customer
Fetch details for a single customer by email or customer code. Returns full customer profile including transactions and subscriptions.
update_customer
Update an existing customer's details. Can modify name, phone, and metadata. Can also whitelist or blacklist a customer by setting the risk action.
list_refunds
Retrieve a paginated list of refunds on your integration. Filter by reference, currency, or date range.
list_payment_requests
Retrieve a paginated list of payment requests/invoices. Filter by customer, status, currency, or date range.
create_customer
Create a new customer record on your Paystack integration. Customers are used to track payment history and manage recurring billing.
list_transactions
Retrieve a list of transactions on your integration. Supports filtering by status, customer, date range, and amount. Returns paginated results.
create_payment_page
Create a hosted payment page that can be shared via link. Useful for collecting payments without building a custom checkout. Amount is in the **smallest currency unit**. Leave amount empty to let the customer enter an amount.
list_transfers
Retrieve a paginated list of transfers. Filter by date range.
create_subaccount
Create a subaccount for splitting payments. Subaccounts represent third-party businesses or vendors that receive a portion of each transaction.
initiate_transfer
Send money to a bank account or mobile money number. You must first create a transfer recipient, then use their recipient code here. The source is always "balance". Amounts are in the **smallest currency unit**.
disable_subscription
Cancel/disable an active subscription. Requires the subscription code and the email token (returned when the subscription was created or can be found in subscription details).
update_payment_page
Update an existing payment page's name, description, amount, or active status.
create_plan
Create a subscription plan that defines recurring billing parameters. Plans specify the amount, currency, and billing interval for automatic charges. Amounts are in the **smallest currency unit** (e.g., kobo for NGN).
verify_bank_account
Resolve and verify a bank account number. Returns the account name for confirmation before creating a transfer recipient. Use the List Banks tool to get the bank code.
create_transfer_recipient
Create a transfer recipient (bank account or mobile money) to receive funds. The recipient code can then be used to initiate transfers.
resolve_card_bin
Look up card details using the first 6 digits (BIN) of a card number. Returns the card brand, type, issuing bank, and country.
create_subscription
Subscribe a customer to an existing plan. The customer must have a valid payment authorization (from a previous transaction). Supports card and direct debit (Nigeria).
initialize_transaction
Initialize a new payment transaction on Paystack. Returns an authorization URL where the customer can complete payment, or use for programmatic charge flows. Amounts are in the **smallest currency unit** (e.g., kobo for NGN: NGN 100 = 10000).
create_payment_request
Create and send an invoice/payment request to a customer. Supports line items, tax, due dates, and notifications. Amounts are in the **smallest currency unit**.
list_subscriptions
Retrieve a paginated list of subscriptions. Filter by customer or plan.
list_settlements
Retrieve a paginated list of settlements (payouts) made by Paystack to your bank account. Provides insight into when funds were settled and for how much.
get_subscription
Fetch details for a single subscription by its ID or code. Returns the subscription's status, plan, customer, billing history, and next payment date.
enable_subscription
Re-enable a previously disabled subscription. Requires the subscription code and the email token.
verify_transaction
Verify the status of a transaction using its reference. Returns full transaction details including payment status, amount, customer, and authorization info.
create_dedicated_virtual_account
Create a dedicated virtual bank account (DVA) for a customer. All bank transfers to this account are automatically recorded as transactions from the customer. Currently only available for Nigeria-based businesses.
Process payments and manage transactions for African businesses. Initialize and verify transactions across multiple payment channels including cards, bank transfers, USSD, mobile money, and QR codes. Create and manage customers, subscriptions, and recurring billing plans. Issue refunds, handle disputes, and track settlements. Transfer funds to bank accounts and mobile money recipients individually or in bulk. Split transaction settlements across multiple subaccounts. Create dedicated virtual accounts for customers, generate payment pages and invoices, and manage products, storefronts, and orders. Verify bank accounts, cards, and customer identities. Receive real-time webhook notifications for transaction, transfer, subscription, invoice, refund, and dispute events.
Common questions about connecting Paystack to AI agents with Metorial.