The Paystack connector lets your AI agent act in each user's Paystack account. Each user connects their own Paystack access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 33 · 24 · 333 read24 write3 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Paystack connection
In AgentKit > Connections, create a Paystack connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'paystack'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Paystack:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'paystack_balance_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "paystack"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Paystack:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="paystack_balance_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Paystack credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolpaystack_balance_getGet the available balance on your integration for each currency.Read-onlyGet Balance
Get the available balance on your integration for each currency. Returns data[] with currency and balance (in the smallest unit). Use paystack_balance_get before initiating transfers.
Inputs
This tool takes no inputs.
paystack_balance_ledger_listList all pay-ins and payouts that changed your balance, optionally for a date range.Read-onlyList Balance Ledger
List all pay-ins and payouts that changed your balance, optionally for a date range. Returns data[] of ledger entries with difference, balance, reason and model_responsible. Use paystack_balance_ledger_list to reconcile the balance.
Inputs
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
paystack_bank_account_resolveLook up the account name for a Nigerian or Ghanaian bank account number.Read-onlyResolve Bank Account
Look up the account name for a Nigerian or Ghanaian bank account number. Returns data with account_number, account_name and bank_id. Use paystack_bank_account_resolve to confirm a beneficiary before paystack_transfer_recipient_create.
Inputs
account_numberstringrequired- Bank account number to resolve. Example: 0001234567.
bank_codestringrequired- Bank code from paystack_banks_list. Example: 058.
paystack_banks_listList banks and mobile money providers Paystack supports, by country, currency or channel type.Read-onlyList Banks
List banks and mobile money providers Paystack supports, by country, currency or channel type. Returns data[] of banks with name, code, slug, currency and type. Use paystack_banks_list to get the bank_code for recipients, subaccounts and account resolution.
Inputs
countrystring- The country from which to obtain the list of supported banks. Example: nigeria.one of
ghanakenyanigeriasouth africa currencystring- Currency to list banks for: GHS, KES, NGN or ZAR. Example: NGN.one of
GHSKESNGNZAR enabled_for_verificationboolean- A flag to filter the banks that are supported for account verification in South Africa. You need to combine this with either the currency or country filter. Example: false.
gatewaystring- The type of gateway for a Nigerian bank. Example: emandate.one of
emandatedigitalbankmandate include_nip_sort_codeboolean- A flag that returns Nigerian banks with their NIP institution code. The returned value can be used in identifying institutions on NIP. Example: false.
pageinteger- Page number to return, starting at 1. Example: 1.
pay_with_bankboolean- A flag to filter for banks a customer can pay directly from. Example: false.
pay_with_bank_transferboolean- A flag to filter for available banks a customer can make a transfer to complete a payment. Example: false.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
typestring- Type of financial channel. Example: nuban.one of
ghippsmobile_moneynubankepssbasa
paystack_countries_listList the countries Paystack supports.Read-onlyList Countries
List the countries Paystack supports. Returns data[] of countries with name, iso_code, default_currency_code and relationships. Use paystack_countries_list to check where a feature is available.
Inputs
This tool takes no inputs.
paystack_customer_getGet a customer by email or customer code.Read-onlyGet Customer
Get a customer by email or customer code. Returns data with the customer's details, authorizations, subscriptions and transactions. Use paystack_customer_get to find a customer's saved authorization_code.
Inputs
codestringrequired- Customer code (CUS_...) or email address. Example: CUS_xnxdt6s1zg1f4nx.
paystack_customers_listList customers, optionally for a date range.Read-onlyList Customers
List customers, optionally for a date range. Returns data[] of customers with customer_code, email, names and phone, and meta with paging. Use paystack_customers_list to browse. Use paystack_customer_get for one customer.
Inputs
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
pagestring- Page number to return, starting at 1. Example: 1.
per_pagestring- Number of records per page. Defaults to 50. Example: 50.
tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
paystack_dispute_getGet a dispute by ID.Read-onlyGet Dispute
Get a dispute by ID. Returns data with status, category, refund amount, transaction, customer and history. Use paystack_dispute_get before resolving a dispute.
Inputs
idintegerrequired- Dispute ID. Example: 2867.
paystack_disputes_listList chargeback disputes, filtered by status, transaction or date range.Read-onlyList Disputes
List chargeback disputes, filtered by status, transaction or date range. Returns data[] of disputes with id, status, refund_amount, transaction and due date. Use paystack_disputes_list to find disputes awaiting your response.
Inputs
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
statusstring- Dispute status. Example: awaiting-merchant-feedback.one of
awaiting-merchant-feedbackawaiting-bank-feedbackpendingresolved tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
transactionstring- Transaction ID to filter by. Example: 4099260516.
paystack_payment_request_getGet a payment request by ID or request code.Read-onlyGet Payment Request
Get a payment request by ID or request code. Returns data with line items, tax, amount, status, customer and pay link. Use paystack_payment_request_get for full invoice details.
Inputs
idstringrequired- Payment request ID or code (PRQ_...). Example: PRQ_1weqqsn2wwzgft8.
paystack_payment_request_verifyCheck whether a payment request has been paid.Read-onlyVerify Payment Request
Check whether a payment request has been paid. Returns data with status, paid, paid_at and amount. Use paystack_payment_request_verify to confirm an invoice was settled.
Inputs
idstringrequired- Payment request code (PRQ_...). Example: PRQ_1weqqsn2wwzgft8.
paystack_payment_requests_listList payment requests, filtered by customer, status, currency or date range.Read-onlyList Payment Requests
List payment requests, filtered by customer, status, currency or date range. Returns data[] of payment requests with request_code, amount, status and customer. Use paystack_payment_requests_list to find outstanding invoices.
Inputs
currencystring- Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.
customerstring- Numeric customer ID to filter by. Example: 63.
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
statusstring- Invoice status to filter. Example: pending.one of
draftpendingsuccessfailed tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
paystack_plan_getGet a plan by ID or plan code.Read-onlyGet Plan
Get a plan by ID or plan code. Returns data with the plan and its subscriptions. Use paystack_plan_get when you have the plan code.
Inputs
codestringrequired- Plan ID or plan code (PLN_...). Example: PLN_gx2wn530m0i3w3m.
paystack_plans_listList recurring plans, optionally filtered by interval, amount or date range.Read-onlyList Plans
List recurring plans, optionally filtered by interval, amount or date range. Returns data[] of plans with plan_code, name, amount, interval and subscriptions. Use paystack_plans_list to find a plan_code.
Inputs
amountinteger- Amount in the currency's smallest unit (kobo for NGN, pesewas for GHS, cents for ZAR, KES and USD). Example: 500000 is NGN 5,000.
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
intervalstring- Specify interval of the plan. Example: monthly.one of
dailyweeklymonthlybiannuallyannually pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
paystack_product_getGet a product by ID.Read-onlyGet Product
Get a product by ID. Returns data with the product's name, description, price, stock and files. Use paystack_product_get when you have the ID.
Inputs
idintegerrequired- Numeric product ID. Example: 526.
paystack_products_listList products, optionally only active ones or for a date range.Read-onlyList Products
List products, optionally only active ones or for a date range. Returns data[] of products with id, name, price, currency and quantity. Use paystack_products_list to browse the catalog.
Inputs
activeboolean- The state of the product. Example: true.
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
paystack_refund_getGet a refund by ID.Read-onlyGet Refund
Get a refund by ID. Returns data with status, amount, transaction, notes and dates. Use paystack_refund_get to check a refund's progress.
Inputs
idintegerrequired- Refund ID. Example: 1.
paystack_refunds_listList refunds, optionally for a date range.Read-onlyList Refunds
List refunds, optionally for a date range. Returns data[] of refunds with id, amount, status, transaction and currency. Use paystack_refunds_list to track refunds.
Inputs
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
paystack_settlement_transactions_listList the transactions included in a settlement.Read-onlyList Settlement Transactions
List the transactions included in a settlement. Returns data[] of transactions and meta. Use paystack_settlement_transactions_list after paystack_settlements_list.
Inputs
idintegerrequired- Settlement ID. Example: 3090024.
paystack_settlements_listList settlements paid out to your bank account.Read-onlyList Settlements
List settlements paid out to your bank account. Returns data[] of settlements with id, total_amount, status, settlement_date and subaccount. Use paystack_settlements_list to reconcile bank deposits.
Inputs
pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
paystack_subaccounts_listList subaccounts, optionally only active ones.Read-onlyList Subaccounts
List subaccounts, optionally only active ones. Returns data[] of subaccounts with subaccount_code, business_name, percentage_charge and bank details. Use paystack_subaccounts_list to find a subaccount code.
Inputs
activeboolean- Filter by the state of the subaccounts. Example: true.
pageinteger- Page number to return, starting at 1. Defaults to 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
paystack_subscription_getGet a subscription by ID or subscription code.Read-onlyGet Subscription
Get a subscription by ID or subscription code. Returns data with status, plan, customer, authorization, email_token and invoices. Use paystack_subscription_get to read the email_token needed to disable or enable it.
Inputs
codestringrequired- Subscription ID or code (SUB_...). Example: SUB_vsyqdmlzble3uii.
paystack_subscriptions_listList subscriptions, optionally for a plan, customer or date range.Read-onlyList Subscriptions
List subscriptions, optionally for a plan, customer or date range. Returns data[] of subscriptions with subscription_code, status, plan, customer and next_payment_date. Use paystack_subscriptions_list to browse subscribers.
Inputs
customerstring- Numeric customer ID to filter by. Example: 63.
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
planinteger- Numeric plan ID to filter by. Example: 28.
tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
paystack_transaction_getGet one transaction by its numeric ID.Read-onlyGet Transaction
Get one transaction by its numeric ID. Returns data with status, amount, fees, channel, customer, authorization and log. Use paystack_transaction_get when you have the ID. Use paystack_transaction_verify when you have the reference.
Inputs
idintegerrequired- Numeric ID of the transaction. Example: 4099260516.
paystack_transaction_timeline_getGet the step-by-step checkout timeline of a transaction.Read-onlyGet Transaction Timeline
Get the step-by-step checkout timeline of a transaction. Returns data with time_spent, attempts, errors and history[] of customer actions. Use paystack_transaction_timeline_get to see why a payment failed or was abandoned.
Inputs
idintegerrequired- ID or reference of the transaction. Example: 4099260516.
paystack_transaction_totals_getGet the total volume and count of transactions, optionally for a date range.Read-onlyGet Transaction Totals
Get the total volume and count of transactions, optionally for a date range. Returns data with total_transactions, total_volume, total_volume_by_currency and pending_transfers. Use paystack_transaction_totals_get for revenue summaries.
Inputs
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
paystack_transaction_verifyConfirm the status of a transaction by its reference.Read-onlyVerify Transaction
Confirm the status of a transaction by its reference. Returns data with status, amount, currency, paid_at, channel, customer and the reusable authorization. Use paystack_transaction_verify after checkout before giving value; use the authorization_code for later charges.
Inputs
referencestringrequired- The transaction reference to verify. Example: sk-order-1001.
paystack_transactions_listList transactions, filtered by status, channel, customer, amount, date range, terminal, settlement, subaccount or split.Read-onlyList Transactions
List transactions, filtered by status, channel, customer, amount, date range, terminal, settlement, subaccount or split. Returns data[] of transactions and meta with paging. Use paystack_transactions_list to search payments. Use paystack_transaction_get for one transaction by ID.
Inputs
amountinteger- Amount in the currency's smallest unit (kobo for NGN, pesewas for GHS, cents for ZAR, KES and USD). Example: 500000 is NGN 5,000.
channelstring- The payment method the customer used to complete the transaction. Example: card.one of
cardposbankdedicated_nubanussdbank_transfer customer_codestring- Filter transactions by a customer code. Example: CUS_xnxdt6s1zg1f4nx.
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
settlementinteger- The settlement ID to filter for settled transactions. Example: 3090024.
sourcestring- The origin of the payment. Example: checkout.one of
merchantApicheckoutposvirtualTerminal split_codestring- Filter transaction by split code. Example: SPL_98WF13Eb3w.
statusstring- Transaction status. Example: success.one of
successfailedabandonedreversed subaccount_codestring- Filter transaction by subaccount code. Example: ACCT_8f4s1eq7ml6rlzj.
terminal_idstring- Filter transactions by a terminal ID. Example: 2232WE17.
tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
virtual_account_numberstring- Filter transactions by a virtual account number. Example: 9930000737.
paystack_transfer_getGet a transfer by ID or transfer code.Read-onlyGet Transfer
Get a transfer by ID or transfer code. Returns data with amount, status, recipient and failure details. Use paystack_transfer_get when you have the transfer code. Use paystack_transfer_verify with your reference.
Inputs
codestringrequired- Transfer ID or code (TRF_...). Example: TRF_vsyqdmlzble3uii.
paystack_transfer_recipient_getGet a transfer recipient by ID or recipient code.Read-onlyGet Transfer Recipient
Get a transfer recipient by ID or recipient code. Returns data with the recipient's name, type and account details. Use paystack_transfer_recipient_get to check payout details.
Inputs
codestringrequired- Recipient ID or code (RCP_...). Example: RCP_t0ya41mp35flk40.
paystack_transfer_recipients_listList transfer recipients.Read-onlyList Transfer Recipients
List transfer recipients. Returns data[] of recipients with recipient_code, name, type and bank details. Use paystack_transfer_recipients_list to find a recipient code.
Inputs
pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
paystack_transfer_verifyCheck a transfer's status by your reference.Read-onlyVerify Transfer
Check a transfer's status by your reference. Returns data with status, amount and recipient. Use paystack_transfer_verify to confirm a payout you initiated.
Inputs
referencestringrequired- Transfer reference. Example: sk-order-1001.
paystack_transfers_listList transfers, filtered by recipient, status or date range.Read-onlyList Transfers
List transfers, filtered by recipient, status or date range. Returns data[] of transfers with transfer_code, amount, status, recipient and reference. Use paystack_transfers_list to review payouts.
Inputs
fromstring- Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
pageinteger- Page number to return, starting at 1. Example: 1.
per_pageinteger- Number of records per page. Defaults to 50. Example: 50.
recipientstring- Filter transfer by the recipient code. Example: RCP_t0ya41mp35flk40.
statusstring- Filter transfer by status. Defaults to pending. Example: success.one of
pendingsuccessfailedotpabandonedreversedblockedrejectedreceived tostring- End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
paystack_customer_createCreate a customer on your integration.WriteCreate Customer
Create a customer on your integration. Returns data with customer_code, id and email. Use paystack_customer_create to register a customer before subscriptions or payment requests.
Inputs
emailstringrequired- Customer's email address. Example: customer@example.com.
first_namestring- Customer's first name. Example: Ada.
last_namestring- Customer's last name. Example: Obi.
metadatastring- Custom data as a stringified JSON object. Example: {"order_id": "1001"}
phonestring- Customer's phone number. Example: +2348012345678.
paystack_customer_risk_action_setWhitelist or blacklist a customer, or reset them to the default fraud rules.WriteSet Customer Risk Action
Whitelist or blacklist a customer, or reset them to the default fraud rules. Returns data with the updated customer and risk_action. Use paystack_customer_risk_action_set with deny to block a fraudulent customer.
Inputs
customerstringrequired- Customer code (CUS_...) or email. Example: CUS_xnxdt6s1zg1f4nx.
risk_actionstring- allow to whitelist, deny to blacklist, default to reset. Example: allow.one of
allowdenydefault
paystack_customer_updateUpdate a customer's name, phone or metadata.WriteUpdate Customer
Update a customer's name, phone or metadata. Returns data with the updated customer. Use paystack_customer_update to correct customer details.
- Idempotent
Inputs
codestringrequired- Customer code (CUS_...). Example: CUS_xnxdt6s1zg1f4nx.
first_namestring- Customer's first name. Example: Ada.
last_namestring- Customer's last name. Example: Obi.
metadatastring- Custom data as a stringified JSON object. Example: {"order_id": "1001"}
phonestring- Customer's phone number. Example: +2348012345678.
paystack_dispute_resolveResolve a dispute by accepting it (refund) or declining it with evidence.WriteResolve Dispute
Resolve a dispute by accepting it (refund) or declining it with evidence. Returns data with the resolved dispute. Use paystack_dispute_resolve after reviewing it with paystack_dispute_get.
- Idempotent
Inputs
idintegerrequired- Dispute ID. Example: 2867.
messagestringrequired- Reason for resolving. Example: Refund issued.
refund_amountintegerrequired- Amount to refund in the smallest unit. Example: 500000.
resolutionstringrequired- merchant-accepted to accept and refund, or declined to contest. Example: merchant-accepted.
uploaded_filenamestringrequired- Filename of the evidence file you uploaded with the dispute upload URL. Example: qesp8a4df1xejihd9x5q.pdf.
evidenceinteger- Evidence Id for fraud claims. Example: 21.
paystack_payment_request_createIssue a payment request (invoice) to a customer, with line items and taxes, emailed unless saved as draft.WriteCreate Payment Request
Issue a payment request (invoice) to a customer, with line items and taxes, emailed unless saved as draft. Returns data with request_code, id, amount, status and due_date. Use paystack_payment_request_create to bill a customer by email with a pay link.
Inputs
amountintegerrequired- Amount in the currency's smallest unit (kobo for NGN, pesewas for GHS, cents for ZAR, KES and USD). Example: 500000 is NGN 5,000.
customerstringrequired- Customer ID or code (CUS_...). Example: CUS_xnxdt6s1zg1f4nx.
currencystring- Currency: NGN, GHS, ZAR or USD. Defaults to your integration currency. Example: NGN.
descriptionstring- A short description of the payment request. Example: Gold tier, billed monthly.
draftboolean- Indicate if request should be saved as draft. Defaults to false and overrides send_notification. Example: false.
due_datestring- Due date in ISO 8601, for example 2026-12-31. Example: 2026-12-31.
has_invoiceboolean- Set to true to create a draft invoice (adds an auto incrementing invoice number if none is provided) even if there are no line_items or tax passed. Example: true.
invoice_numberinteger- Numeric value of invoice. Invoice will start from 1 and auto increment from there. This field is to help override whatever value Paystack decides. Auto increment for subsequent invoices continue from this point. Example: 1001.
line_itemsarray- Line items, each with name, amount (smallest unit) and quantity. Example: [{"name": "Website design", "amount": 250000, "quantity": 1}].
send_notificationboolean- Indicates whether Paystack sends an email notification to customer. Defaults to true. Example: true.
split_codestring- The split code of the transaction split. Example: SPL_98WF13Eb3w.
taxarray- Taxes, each with name and amount (smallest unit). Example: [{"name": "VAT", "amount": 18750}].
paystack_payment_request_finalizeFinalize a draft payment request and send it to the customer.WriteFinalize Payment Request
Finalize a draft payment request and send it to the customer. Returns data with the finalized payment request. Use paystack_payment_request_finalize after creating a request with draft true.
Inputs
idstringrequired- Payment request code (PRQ_...). Example: PRQ_1weqqsn2wwzgft8.
paystack_payment_request_notifyEmail a payment request reminder to its customer.WriteSend Payment Request Notification
Email a payment request reminder to its customer. Returns status and message. Use paystack_payment_request_notify to nudge a customer about an unpaid invoice.
Inputs
idstringrequired- Payment request code (PRQ_...). Example: PRQ_1weqqsn2wwzgft8.
paystack_payment_request_updateUpdate a payment request's customer, amount, items, taxes, due date or description.WriteUpdate Payment Request
Update a payment request's customer, amount, items, taxes, due date or description. Returns data with the updated payment request. Use paystack_payment_request_update to correct an invoice before it is paid.
- Idempotent
Inputs
idstringrequired- Payment request ID or code (PRQ_...). Example: PRQ_1weqqsn2wwzgft8.
amountinteger- Amount in the currency's smallest unit (kobo for NGN, pesewas for GHS, cents for ZAR, KES and USD). Example: 500000 is NGN 5,000.
currencystring- Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.
customerstring- Customer ID or code (CUS_...). Example: CUS_xnxdt6s1zg1f4nx.
descriptionstring- A short description of the payment request. Example: Gold tier, billed monthly.
draftboolean- Indicate if request should be saved as draft. Defaults to false and overrides send_notification. Example: false.
due_datestring- Due date in ISO 8601. Example: 2026-12-31.
has_invoiceboolean- Set to true to create a draft invoice (adds an auto incrementing invoice number if none is provided) even if there are no line_items or tax passed. Example: true.
invoice_numberinteger- Numeric value of invoice. Invoice will start from 1 and auto increment from there. This field is to help override whatever value Paystack decides. Auto increment for subsequent invoices continue from this point. Example: 1001.
line_itemsarray- Line items, each with name, amount (smallest unit) and quantity. Example: [{"name": "Website design", "amount": 250000, "quantity": 1}]
send_notificationboolean- Indicates whether Paystack sends an email notification to customer. Defaults to true. Example: true.
split_codestring- The split code of the transaction split. Example: SPL_98WF13Eb3w.
taxarray- Taxes, each with name and amount (smallest unit). Example: [{"name": "VAT", "amount": 18750}]
paystack_plan_createCreate a recurring payment plan.WriteCreate Plan
Create a recurring payment plan. Returns data with plan_code, name, amount and interval. Use paystack_plan_create before paystack_subscription_create.
Inputs
amountintegerrequired- Amount in the currency's smallest unit (kobo for NGN, pesewas for GHS, cents for ZAR, KES and USD). Example: 500000 is NGN 5,000.
intervalstringrequired- Payment interval. Example: monthly.one of
dailyweeklymonthlybiannuallyannually namestringrequired- Name of plan. Example: Monthly Gold.
currencystring- Currency of the amount: NGN, GHS, ZAR or USD. Example: NGN.
descriptionstring- A description for this plan. Example: Gold tier, billed monthly.
invoice_limitinteger- Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing. Example: 12.
send_invoicesboolean- Set to false if you don't want invoices to be sent to your customers. Example: true.
send_smsboolean- Set to false if you don't want text messages to be sent to your customers. Example: false.
paystack_plan_updateUpdate a plan's name, amount, interval or settings.WriteUpdate Plan
Update a plan's name, amount, interval or settings. Returns status and message. Use paystack_plan_update to change pricing for new subscriptions.
- Idempotent
Inputs
codestringrequired- Plan ID or plan code (PLN_...). Example: PLN_gx2wn530m0i3w3m.
amountinteger- Amount in the currency's smallest unit (kobo for NGN, pesewas for GHS, cents for ZAR, KES and USD). Example: 500000 is NGN 5,000.
currencystring- Currency of the amount: NGN, GHS, ZAR or USD. Example: NGN.
descriptionstring- A description for this plan. Example: Gold tier, billed monthly.
intervalstring- Payment interval. Example: monthly.one of
dailyweeklymonthlybiannuallyannually invoice_limitinteger- Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing. Example: 12.
namestring- Name of plan. Example: Monthly Gold.
send_invoicesboolean- Set to false if you don't want invoices to be sent to your customers. Example: true.
send_smsboolean- Set to false if you don't want text messages to be sent to your customers. Example: false.
paystack_product_createCreate a product to sell on Paystack pages and storefronts.WriteCreate Product
Create a product to sell on Paystack pages and storefronts. Returns data with product id, product_code, name and price. Use paystack_product_create to add an item to your catalog.
Inputs
currencystringrequired- Currency of the price: NGN, GHS, ZAR or USD. Example: NGN.
descriptionstringrequired- The description of the product. Example: Cotton T-shirt, size M.
namestringrequired- Name of product. Example: Acme T-shirt.
priceintegerrequired- Price in the currency's smallest unit. Example: 500000.
metadatastring- Custom data as a stringified JSON object. Example: {"order_id": "1001"}
quantityinteger- Number of products in stock. Use if limited is true. Example: 100.
split_codestring- The split code if sharing the transaction with partners. Example: SPL_98WF13Eb3w.
unlimitedboolean- Set to true for unlimited stock; leave false and set quantity for limited stock. Example: false.
paystack_product_updateUpdate a product's name, description, price, currency or stock.WriteUpdate Product
Update a product's name, description, price, currency or stock. Returns data with the updated product. Use paystack_product_update to change a price or restock.
- Idempotent
Inputs
idintegerrequired- Numeric product ID. Example: 526.
currencystring- Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.
descriptionstring- The description of the product. Example: Cotton T-shirt, size M.
metadataobject- Custom data as a JSON object. Example: {"sku": "TS-M"}
namestring- Name of product. Example: Acme T-shirt.
priceinteger- Price in the currency's smallest unit. Example: 500000.
quantityinteger- Number of products in stock. Use if limited is true. Example: 100.
split_codestring- The split code if sharing the transaction with partners. Example: SPL_98WF13Eb3w.
unlimitedboolean- Set to true if the product has unlimited stock. Leave as false if the product has limited stock. Example: false.
paystack_refund_createRefund a completed transaction in full or in part.WriteCreate Refund
Refund a completed transaction in full or in part. Returns data with the refund status, amount and transaction. Use paystack_refund_create to return money to a customer.
Inputs
transactionstringrequired- Reference or ID of the transaction to refund. Example: sk-order-1001.
amountinteger- Amount to refund in the smallest unit; defaults to the full transaction amount. Example: 500000.
currencystring- Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.one of
GHSKESNGNUSDZAR customer_notestring- Customer reason. Example: Item out of stock.
merchant_notestring- Merchant reason. Example: Refund approved by support.
paystack_subaccount_createCreate a subaccount for a partner who receives a share of payments.WriteCreate Subaccount
Create a subaccount for a partner who receives a share of payments. Returns data with subaccount_code, business_name and settlement details. Use paystack_subaccount_create to set up split payments. Get bank codes from paystack_banks_list.
Inputs
account_numberstringrequired- Bank account number. Example: 0001234567.
business_namestringrequired- Name of business for subaccount. Example: Acme Partners.
percentage_chargenumberrequired- Percentage of each transaction the main account keeps, for example 18.2. Example: 18.2.
settlement_bankstringrequired- Bank code of the subaccount's bank, from paystack_banks_list. Example: 058.
descriptionstring- A description for this subaccount. Example: Gold tier, billed monthly.
metadatastring- Custom data as a stringified JSON object. Example: {"order_id": "1001"}
primary_contact_emailstring- A contact email for the subaccount. Example: partner@example.com.
primary_contact_namestring- The name of the contact person for this subaccount. Example: Chidi Okafor.
primary_contact_phonestring- A phone number to call for this subaccount. Example: +2348012345679.
paystack_subscription_createSubscribe an existing customer with a saved authorization to a plan.WriteCreate Subscription
Subscribe an existing customer with a saved authorization to a plan. Returns data with subscription_code, email_token, status and next_payment_date. Use paystack_subscription_create for customers who already paid once. New customers subscribe through paystack_transaction_initialize with plan set.
Inputs
customerstringrequired- Customer's email address or customer code. Example: CUS_xnxdt6s1zg1f4nx.
planstringrequired- Plan code. Example: PLN_gx2wn530m0i3w3m.
authorizationstring- If customer has multiple authorizations, you can set the desired authorization you wish to use for this subscription here. If this is not supplied, the customer's most recent authorization would be used. Example: AUTH_72btv547.
start_datestring- Date of the first debit in ISO 8601, for example 2026-12-01T00:00:00+01:00. Example: 2026-12-01T00:00:00+01:00.
paystack_subscription_enableRe-enable a disabled subscription.WriteEnable Subscription
Re-enable a disabled subscription. Returns status and message. Use paystack_subscription_enable to resume a cancelled subscription.
Inputs
codestringrequired- Subscription code (SUB_...). Example: SUB_vsyqdmlzble3uii.
tokenstringrequired- The subscription's email_token from paystack_subscription_get. Example: d7gofp6yppn3qz7.
paystack_subscription_manage_link_getGenerate a link the customer can use to update the card on a subscription.WriteGet Subscription Manage Link
Generate a link the customer can use to update the card on a subscription. Returns data with link. Use paystack_subscription_manage_link_get when a subscriber's card expired.
- Idempotent
Inputs
codestringrequired- Subscription code (SUB_...). Example: SUB_vsyqdmlzble3uii.
paystack_transaction_initializeStart a payment and get a checkout URL to send the customer to.WriteInitialize Transaction
Start a payment and get a checkout URL to send the customer to. Returns data with authorization_url, access_code and reference. Use paystack_transaction_initialize to collect a new card or bank payment. Use paystack_transaction_verify afterwards to confirm it.
Inputs
amountintegerrequired- Amount in the currency's smallest unit (kobo for NGN, pesewas for GHS, cents for ZAR, KES and USD). Example: 500000 is NGN 5,000.
emailstringrequired- Customer's email address. Example: customer@example.com.
bearerstring- The bearer of the transaction charge. Example: account.one of
accountsubaccount callback_urlstring- Fully qualified url, e.g. https://example.com/ to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction. Example: https://example.com/paystack/callback.
channelsarray- Payment channels to offer, any of card, bank, apple_pay, ussd, qr, mobile_money, bank_transfer, eft. Example: ["card", "bank_transfer"]
currencystring- Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.one of
GHSKESNGNZARUSD invoice_limitinteger- Number of times to charge customer during subscription to plan. Example: 12.
labelstring- Used to replace the email address shown on the Checkout. Example: Acme Store.
metadataobject- Custom data as a JSON object. Example: {"order_id": "1001"}
planstring- If transaction is to create a subscription to a predefined plan, provide plan code here. This would invalidate the value provided in amount. Example: PLN_gx2wn530m0i3w3m.
referencestring- Unique transaction reference. Only -, ., = and alphanumeric characters allowed. Example: sk-order-1001.
split_codestring- The split code of the transaction split. Example: SPL_98WF13Eb3w.
subaccountstring- The code for the subaccount that owns the payment. Example: ACCT_8f4s1eq7ml6rlzj.
transaction_chargestring- A flat fee to charge the subaccount for a transaction. This overrides the split percentage set when the subaccount was created. Example: 10000.
paystack_transaction_partial_debitDebit as much as possible, down to a minimum, from a saved authorization when the full amount is not available.WritePartial Debit
Debit as much as possible, down to a minimum, from a saved authorization when the full amount is not available. Returns data with the transaction status and the amount actually charged. Use paystack_transaction_partial_debit to recover overdue payments in part.
Inputs
amountintegerrequired- Amount in the currency's smallest unit (kobo for NGN, pesewas for GHS, cents for ZAR, KES and USD). Example: 500000 is NGN 5,000.
authorization_codestringrequired- Valid authorization code to charge. Example: AUTH_72btv547.
currencystringrequired- Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.one of
GHSKESNGNZARUSD emailstringrequired- Customer's email address. Example: customer@example.com.
at_leaststring- Minimum amount to charge, in the currency's smallest unit. Example: 100000.
referencestring- Unique transaction reference. Only -, ., = and alphanumeric characters allowed. Example: sk-order-1001.
paystack_transfer_finalizeComplete a transfer that is waiting for an OTP.WriteFinalize Transfer
Complete a transfer that is waiting for an OTP. Returns data with the transfer status. Use paystack_transfer_finalize after paystack_transfer_initiate returns status otp.
Inputs
otpstringrequired- OTP sent to business phone to verify transfer. Example: 928783.
transfer_codestringrequired- The transfer code you want to finalize. Example: TRF_vsyqdmlzble3uii.
paystack_transfer_initiateSend money from your Paystack balance to a transfer recipient.WriteInitiate Transfer
Send money from your Paystack balance to a transfer recipient. Returns data with transfer_code, status (success, pending or otp) and reference. Use paystack_transfer_initiate for payouts. If status is otp, complete it with paystack_transfer_finalize.
Inputs
amountintegerrequired- Amount in the currency's smallest unit (kobo for NGN, pesewas for GHS, cents for ZAR, KES and USD). Example: 500000 is NGN 5,000.
recipientstringrequired- The transfer recipient's code. Example: RCP_t0ya41mp35flk40.
referencestringrequired- Unique reference (lowercase letters, digits, - and _) that makes the request idempotent. Example: sk-order-1001.
sourcestringrequired- Source of funds; only balance is supported. Example: balance.
currencystring- Currency of the transfer: NGN, ZAR, KES or GHS. Example: NGN.one of
NGNZARKESGHS reasonstring- The reason or narration for the transfer. Example: Vendor payout.
paystack_transfer_recipient_createCreate a beneficiary for payouts: a bank account, mobile money wallet or saved card authorization.WriteCreate Transfer Recipient
Create a beneficiary for payouts: a bank account, mobile money wallet or saved card authorization. Returns data with recipient_code and details. A duplicate account number returns the existing recipient. Use paystack_transfer_recipient_create before paystack_transfer_initiate. Resolve the account with paystack_bank_account_resolve first.
Inputs
account_numberstringrequired- Recipient's bank account number. Example: 0001234567.
bank_codestringrequired- Bank code from paystack_banks_list. Example: 058.
namestringrequired- The recipient's name according to their account registration. Example: Monthly Gold.
typestringrequired- Recipient type: nuban (Nigerian bank), ghipss (Ghana bank), mobile_money, basa (South African bank) or authorization. Example: nuban.one of
nubanghipssmobile_moneybasaauthorization authorization_codestring- An authorization code from a previous transaction. Example: AUTH_72btv547.
currencystring- Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.
descriptionstring- A description for this recipient. Example: Gold tier, billed monthly.
metadataobject- Custom data as a stringified JSON object. Example: {"vendor_id": "V-77"}
paystack_transfer_recipient_updateUpdate a transfer recipient's name or email.WriteUpdate Transfer Recipient
Update a transfer recipient's name or email. Returns status and message. Use paystack_transfer_recipient_update to correct recipient details.
- Idempotent
Inputs
codestringrequired- Recipient ID or code (RCP_...). Example: RCP_t0ya41mp35flk40.
emailstring- Recipient's email address. Example: customer@example.com.
namestring- Recipient's name. Example: Acme Supplies Ltd.
paystack_subscription_disableCancel a subscription so it stops charging.DestructiveDisable Subscription
Cancel a subscription so it stops charging. Returns status and message. Use paystack_subscription_disable to cancel; get the email token from paystack_subscription_get.
Inputs
codestringrequired- Subscription code (SUB_...). Example: SUB_vsyqdmlzble3uii.
tokenstringrequired- The subscription's email_token from paystack_subscription_get. Example: d7gofp6yppn3qz7.
paystack_transfer_recipient_deleteDelete (deactivate) a transfer recipient.DestructiveDelete Transfer Recipient
Delete (deactivate) a transfer recipient. Returns status and message. Use paystack_transfer_recipient_delete to stop paying a beneficiary.
- Idempotent
Inputs
codestringrequired- Recipient ID or code (RCP_...). Example: RCP_t0ya41mp35flk40.
No tools match.