Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Paystack

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  3. Create the Paystack connection

    In AgentKit > Connections, create a Paystack connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. 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.actions
    const connector = 'paystack'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { 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 call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'paystack_balance_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each 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 to execute_tool
Try in PlaygroundRequest a tool
  • paystack_balance_getGet the available balance on your integration for each currency.Read-only

    Get 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-only

    List 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-only

    Resolve 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-only

    List 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-only

    List 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-only

    Get 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-only

    List 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-only

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