> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Paystack

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.

**Authentication:** Bearer Token
**Categories:** Accounting & Finance
**Tools:** 60: 33 read, 24 write, 3 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=PAYSTACK)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".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](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_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.actions

   connection_name = "paystack"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_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 call
   result = actions.execute_tool(
       tool_input={},
       tool_name="paystack_balance_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Paystack credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'paystack_balance_get',
  toolInput: {},
  connector: 'paystack',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="paystack_balance_get",
    tool_input={},
    connection_name="paystack",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `paystack_balance_get`

Get Balance · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `paystack_balance_ledger_list`

List Balance Ledger · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.

Example input: `{}`

### `paystack_bank_account_resolve`

Resolve Bank Account · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account_number` (`string`, required): Bank account number to resolve. Example: 0001234567.
- `bank_code` (`string`, required): Bank code from paystack_banks_list. Example: 058.

Example input: `{"account_number":"<account_number>","bank_code":"<bank_code>"}`

### `paystack_banks_list`

List Banks · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `country` (`string`, optional): The country from which to obtain the list of supported banks. Example: nigeria. One of: `ghana`, `kenya`, `nigeria`, `south africa`.
- `currency` (`string`, optional): Currency to list banks for: GHS, KES, NGN or ZAR. Example: NGN. One of: `GHS`, `KES`, `NGN`, `ZAR`.
- `enabled_for_verification` (`boolean`, optional): 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.
- `gateway` (`string`, optional): The type of gateway for a Nigerian bank. Example: emandate. One of: `emandate`, `digitalbankmandate`.
- `include_nip_sort_code` (`boolean`, optional): A flag that returns Nigerian banks with their NIP institution code. The returned value can be used in identifying institutions on NIP. Example: false.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `pay_with_bank` (`boolean`, optional): A flag to filter for banks a customer can pay directly from. Example: false.
- `pay_with_bank_transfer` (`boolean`, optional): A flag to filter for available banks a customer can make a transfer to complete a payment. Example: false.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.
- `type` (`string`, optional): Type of financial channel. Example: nuban. One of: `ghipps`, `mobile_money`, `nuban`, `kepss`, `basa`.

Example input: `{}`

### `paystack_countries_list`

List Countries · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `paystack_customer_get`

Get Customer · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Customer code (CUS_...) or email address. Example: CUS_xnxdt6s1zg1f4nx.

Example input: `{"code":"<code>"}`

### `paystack_customers_list`

List Customers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `page` (`string`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`string`, optional): Number of records per page. Defaults to 50. Example: 50.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.

Example input: `{}`

### `paystack_dispute_get`

Get Dispute · Read-only

Get a dispute by ID.
Returns data with status, category, refund amount, transaction, customer and history.
Use paystack_dispute_get before resolving a dispute.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Dispute ID. Example: 2867.

Example input: `{"id":2867}`

### `paystack_disputes_list`

List Disputes · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.
- `status` (`string`, optional): Dispute status. Example: awaiting-merchant-feedback. One of: `awaiting-merchant-feedback`, `awaiting-bank-feedback`, `pending`, `resolved`.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
- `transaction` (`string`, optional): Transaction ID to filter by. Example: 4099260516.

Example input: `{}`

### `paystack_payment_request_get`

Get Payment Request · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Payment request ID or code (PRQ_...). Example: PRQ_1weqqsn2wwzgft8.

Example input: `{"id":"<id>"}`

### `paystack_payment_request_verify`

Verify Payment Request · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Payment request code (PRQ_...). Example: PRQ_1weqqsn2wwzgft8.

Example input: `{"id":"<id>"}`

### `paystack_payment_requests_list`

List Payment Requests · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `currency` (`string`, optional): Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.
- `customer` (`string`, optional): Numeric customer ID to filter by. Example: 63.
- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.
- `status` (`string`, optional): Invoice status to filter. Example: pending. One of: `draft`, `pending`, `success`, `failed`.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.

Example input: `{}`

### `paystack_plan_get`

Get Plan · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Plan ID or plan code (PLN_...). Example: PLN_gx2wn530m0i3w3m.

Example input: `{"code":"<code>"}`

### `paystack_plans_list`

List Plans · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `amount` (`integer`, optional): 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.
- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `interval` (`string`, optional): Specify interval of the plan. Example: monthly. One of: `daily`, `weekly`, `monthly`, `biannually`, `annually`.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.

Example input: `{}`

### `paystack_product_get`

Get Product · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Numeric product ID. Example: 526.

Example input: `{"id":526}`

### `paystack_products_list`

List Products · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`boolean`, optional): The state of the product. Example: true.
- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.

Example input: `{}`

### `paystack_refund_get`

Get Refund · Read-only

Get a refund by ID.
Returns data with status, amount, transaction, notes and dates.
Use paystack_refund_get to check a refund's progress.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Refund ID. Example: 1.

Example input: `{"id":1}`

### `paystack_refunds_list`

List Refunds · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.

Example input: `{}`

### `paystack_settlement_transactions_list`

List Settlement Transactions · Read-only

List the transactions included in a settlement.
Returns data[] of transactions and meta.
Use paystack_settlement_transactions_list after paystack_settlements_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Settlement ID. Example: 3090024.

Example input: `{"id":3090024}`

### `paystack_settlements_list`

List Settlements · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.

Example input: `{}`

### `paystack_subaccounts_list`

List Subaccounts · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`boolean`, optional): Filter by the state of the subaccounts. Example: true.
- `page` (`integer`, optional): Page number to return, starting at 1. Defaults to 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.

Example input: `{}`

### `paystack_subscription_get`

Get Subscription · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Subscription ID or code (SUB_...). Example: SUB_vsyqdmlzble3uii.

Example input: `{"code":"<code>"}`

### `paystack_subscriptions_list`

List Subscriptions · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer` (`string`, optional): Numeric customer ID to filter by. Example: 63.
- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.
- `plan` (`integer`, optional): Numeric plan ID to filter by. Example: 28.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.

Example input: `{}`

### `paystack_transaction_get`

Get Transaction · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Numeric ID of the transaction. Example: 4099260516.

Example input: `{"id":4099260516}`

### `paystack_transaction_timeline_get`

Get Transaction Timeline · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID or reference of the transaction. Example: 4099260516.

Example input: `{"id":4099260516}`

### `paystack_transaction_totals_get`

Get Transaction Totals · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.

Example input: `{}`

### `paystack_transaction_verify`

Verify Transaction · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference` (`string`, required): The transaction reference to verify. Example: sk-order-1001.

Example input: `{"reference":"<reference>"}`

### `paystack_transactions_list`

List Transactions · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `amount` (`integer`, optional): 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.
- `channel` (`string`, optional): The payment method the customer used to complete the transaction. Example: card. One of: `card`, `pos`, `bank`, `dedicated_nuban`, `ussd`, `bank_transfer`.
- `customer_code` (`string`, optional): Filter transactions by a customer code. Example: CUS_xnxdt6s1zg1f4nx.
- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.
- `settlement` (`integer`, optional): The settlement ID to filter for settled transactions. Example: 3090024.
- `source` (`string`, optional): The origin of the payment. Example: checkout. One of: `merchantApi`, `checkout`, `pos`, `virtualTerminal`.
- `split_code` (`string`, optional): Filter transaction by split code. Example: SPL_98WF13Eb3w.
- `status` (`string`, optional): Transaction status. Example: success. One of: `success`, `failed`, `abandoned`, `reversed`.
- `subaccount_code` (`string`, optional): Filter transaction by subaccount code. Example: ACCT_8f4s1eq7ml6rlzj.
- `terminal_id` (`string`, optional): Filter transactions by a terminal ID. Example: 2232WE17.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.
- `virtual_account_number` (`string`, optional): Filter transactions by a virtual account number. Example: 9930000737.

Example input: `{}`

### `paystack_transfer_get`

Get Transfer · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Transfer ID or code (TRF_...). Example: TRF_vsyqdmlzble3uii.

Example input: `{"code":"<code>"}`

### `paystack_transfer_recipient_get`

Get Transfer Recipient · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Recipient ID or code (RCP_...). Example: RCP_t0ya41mp35flk40.

Example input: `{"code":"<code>"}`

### `paystack_transfer_recipients_list`

List Transfer Recipients · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.

Example input: `{}`

### `paystack_transfer_verify`

Verify Transfer · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference` (`string`, required): Transfer reference. Example: sk-order-1001.

Example input: `{"reference":"<reference>"}`

### `paystack_transfers_list`

List Transfers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from` (`string`, optional): Start date (and optional time) of the period, for example 2026-11-01. Example: 2026-11-01.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Number of records per page. Defaults to 50. Example: 50.
- `recipient` (`string`, optional): Filter transfer by the recipient code. Example: RCP_t0ya41mp35flk40.
- `status` (`string`, optional): Filter transfer by status. Defaults to pending. Example: success. One of: `pending`, `success`, `failed`, `otp`, `abandoned`, `reversed`, `blocked`, `rejected`, `received`.
- `to` (`string`, optional): End date (and optional time) of the period, for example 2026-11-30. Example: 2026-11-30.

Example input: `{}`

### `paystack_customer_create`

Create Customer · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Customer's email address. Example: customer@example.com.
- `first_name` (`string`, optional): Customer's first name. Example: Ada.
- `last_name` (`string`, optional): Customer's last name. Example: Obi.
- `metadata` (`string`, optional): Custom data as a stringified JSON object. Example: {"order_id": "1001"}
- `phone` (`string`, optional): Customer's phone number. Example: +2348012345678.

Example input: `{"email":"<email>"}`

### `paystack_customer_risk_action_set`

Set Customer Risk Action · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer` (`string`, required): Customer code (CUS_...) or email. Example: CUS_xnxdt6s1zg1f4nx.
- `risk_action` (`string`, optional): allow to whitelist, deny to blacklist, default to reset. Example: allow. One of: `allow`, `deny`, `default`.

Example input: `{"customer":"<customer>"}`

### `paystack_customer_update`

Update Customer · Write

Update a customer's name, phone or metadata.
Returns data with the updated customer.
Use paystack_customer_update to correct customer details.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Customer code (CUS_...). Example: CUS_xnxdt6s1zg1f4nx.
- `first_name` (`string`, optional): Customer's first name. Example: Ada.
- `last_name` (`string`, optional): Customer's last name. Example: Obi.
- `metadata` (`string`, optional): Custom data as a stringified JSON object. Example: {"order_id": "1001"}
- `phone` (`string`, optional): Customer's phone number. Example: +2348012345678.

Example input: `{"code":"<code>"}`

### `paystack_dispute_resolve`

Resolve Dispute · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Dispute ID. Example: 2867.
- `message` (`string`, required): Reason for resolving. Example: Refund issued.
- `refund_amount` (`integer`, required): Amount to refund in the smallest unit. Example: 500000.
- `resolution` (`string`, required): merchant-accepted to accept and refund, or declined to contest. Example: merchant-accepted.
- `uploaded_filename` (`string`, required): Filename of the evidence file you uploaded with the dispute upload URL. Example: qesp8a4df1xejihd9x5q.pdf.
- `evidence` (`integer`, optional): Evidence Id for fraud claims. Example: 21.

Example input: `{"id":2867,"message":"<message>","refund_amount":500000,"resolution":"<resolution>","uploaded_filename":"<uploaded_filename>"}`

### `paystack_payment_request_create`

Create Payment Request · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount` (`integer`, required): 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.
- `customer` (`string`, required): Customer ID or code (CUS_...). Example: CUS_xnxdt6s1zg1f4nx.
- `currency` (`string`, optional): Currency: NGN, GHS, ZAR or USD. Defaults to your integration currency. Example: NGN.
- `description` (`string`, optional): A short description of the payment request. Example: Gold tier, billed monthly.
- `draft` (`boolean`, optional): Indicate if request should be saved as draft. Defaults to false and overrides send_notification. Example: false.
- `due_date` (`string`, optional): Due date in ISO 8601, for example 2026-12-31. Example: 2026-12-31.
- `has_invoice` (`boolean`, optional): 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_number` (`integer`, optional): 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_items` (`array`, optional): Line items, each with name, amount (smallest unit) and quantity. Example: [{"name": "Website design", "amount": 250000, "quantity": 1}].
- `send_notification` (`boolean`, optional): Indicates whether Paystack sends an email notification to customer. Defaults to true. Example: true.
- `split_code` (`string`, optional): The split code of the transaction split. Example: SPL_98WF13Eb3w.
- `tax` (`array`, optional): Taxes, each with name and amount (smallest unit). Example: [{"name": "VAT", "amount": 18750}].

Example input: `{"amount":500000,"customer":"<customer>"}`

### `paystack_payment_request_finalize`

Finalize Payment Request · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Payment request code (PRQ_...). Example: PRQ_1weqqsn2wwzgft8.

Example input: `{"id":"<id>"}`

### `paystack_payment_request_notify`

Send Payment Request Notification · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Payment request code (PRQ_...). Example: PRQ_1weqqsn2wwzgft8.

Example input: `{"id":"<id>"}`

### `paystack_payment_request_update`

Update Payment Request · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Payment request ID or code (PRQ_...). Example: PRQ_1weqqsn2wwzgft8.
- `amount` (`integer`, optional): 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.
- `currency` (`string`, optional): Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.
- `customer` (`string`, optional): Customer ID or code (CUS_...). Example: CUS_xnxdt6s1zg1f4nx.
- `description` (`string`, optional): A short description of the payment request. Example: Gold tier, billed monthly.
- `draft` (`boolean`, optional): Indicate if request should be saved as draft. Defaults to false and overrides send_notification. Example: false.
- `due_date` (`string`, optional): Due date in ISO 8601. Example: 2026-12-31.
- `has_invoice` (`boolean`, optional): 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_number` (`integer`, optional): 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_items` (`array`, optional): Line items, each with name, amount (smallest unit) and quantity. Example: [{"name": "Website design", "amount": 250000, "quantity": 1}]
- `send_notification` (`boolean`, optional): Indicates whether Paystack sends an email notification to customer. Defaults to true. Example: true.
- `split_code` (`string`, optional): The split code of the transaction split. Example: SPL_98WF13Eb3w.
- `tax` (`array`, optional): Taxes, each with name and amount (smallest unit). Example: [{"name": "VAT", "amount": 18750}]

Example input: `{"id":"<id>"}`

### `paystack_plan_create`

Create Plan · Write

Create a recurring payment plan.
Returns data with plan_code, name, amount and interval.
Use paystack_plan_create before paystack_subscription_create.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount` (`integer`, required): 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.
- `interval` (`string`, required): Payment interval. Example: monthly. One of: `daily`, `weekly`, `monthly`, `biannually`, `annually`.
- `name` (`string`, required): Name of plan. Example: Monthly Gold.
- `currency` (`string`, optional): Currency of the amount: NGN, GHS, ZAR or USD. Example: NGN.
- `description` (`string`, optional): A description for this plan. Example: Gold tier, billed monthly.
- `invoice_limit` (`integer`, optional): Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing. Example: 12.
- `send_invoices` (`boolean`, optional): Set to false if you don't want invoices to be sent to your customers. Example: true.
- `send_sms` (`boolean`, optional): Set to false if you don't want text messages to be sent to your customers. Example: false.

Example input: `{"amount":500000,"interval":"daily","name":"<name>"}`

### `paystack_plan_update`

Update Plan · Write

Update a plan's name, amount, interval or settings.
Returns status and message.
Use paystack_plan_update to change pricing for new subscriptions.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Plan ID or plan code (PLN_...). Example: PLN_gx2wn530m0i3w3m.
- `amount` (`integer`, optional): 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.
- `currency` (`string`, optional): Currency of the amount: NGN, GHS, ZAR or USD. Example: NGN.
- `description` (`string`, optional): A description for this plan. Example: Gold tier, billed monthly.
- `interval` (`string`, optional): Payment interval. Example: monthly. One of: `daily`, `weekly`, `monthly`, `biannually`, `annually`.
- `invoice_limit` (`integer`, optional): Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing. Example: 12.
- `name` (`string`, optional): Name of plan. Example: Monthly Gold.
- `send_invoices` (`boolean`, optional): Set to false if you don't want invoices to be sent to your customers. Example: true.
- `send_sms` (`boolean`, optional): Set to false if you don't want text messages to be sent to your customers. Example: false.

Example input: `{"code":"<code>"}`

### `paystack_product_create`

Create Product · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `currency` (`string`, required): Currency of the price: NGN, GHS, ZAR or USD. Example: NGN.
- `description` (`string`, required): The description of the product. Example: Cotton T-shirt, size M.
- `name` (`string`, required): Name of product. Example: Acme T-shirt.
- `price` (`integer`, required): Price in the currency's smallest unit. Example: 500000.
- `metadata` (`string`, optional): Custom data as a stringified JSON object. Example: {"order_id": "1001"}
- `quantity` (`integer`, optional): Number of products in stock. Use if limited is true. Example: 100.
- `split_code` (`string`, optional): The split code if sharing the transaction with partners. Example: SPL_98WF13Eb3w.
- `unlimited` (`boolean`, optional): Set to true for unlimited stock; leave false and set quantity for limited stock. Example: false.

Example input: `{"currency":"<currency>","description":"<description>","name":"<name>","price":500000}`

### `paystack_product_update`

Update Product · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Numeric product ID. Example: 526.
- `currency` (`string`, optional): Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.
- `description` (`string`, optional): The description of the product. Example: Cotton T-shirt, size M.
- `metadata` (`object`, optional): Custom data as a JSON object. Example: {"sku": "TS-M"}
- `name` (`string`, optional): Name of product. Example: Acme T-shirt.
- `price` (`integer`, optional): Price in the currency's smallest unit. Example: 500000.
- `quantity` (`integer`, optional): Number of products in stock. Use if limited is true. Example: 100.
- `split_code` (`string`, optional): The split code if sharing the transaction with partners. Example: SPL_98WF13Eb3w.
- `unlimited` (`boolean`, optional): Set to true if the product has unlimited stock. Leave as false if the product has limited stock. Example: false.

Example input: `{"id":526}`

### `paystack_refund_create`

Create Refund · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `transaction` (`string`, required): Reference or ID of the transaction to refund. Example: sk-order-1001.
- `amount` (`integer`, optional): Amount to refund in the smallest unit; defaults to the full transaction amount. Example: 500000.
- `currency` (`string`, optional): Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN. One of: `GHS`, `KES`, `NGN`, `USD`, `ZAR`.
- `customer_note` (`string`, optional): Customer reason. Example: Item out of stock.
- `merchant_note` (`string`, optional): Merchant reason. Example: Refund approved by support.

Example input: `{"transaction":"<transaction>"}`

### `paystack_subaccount_create`

Create Subaccount · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `account_number` (`string`, required): Bank account number. Example: 0001234567.
- `business_name` (`string`, required): Name of business for subaccount. Example: Acme Partners.
- `percentage_charge` (`number`, required): Percentage of each transaction the main account keeps, for example 18.2. Example: 18.2.
- `settlement_bank` (`string`, required): Bank code of the subaccount's bank, from paystack_banks_list. Example: 058.
- `description` (`string`, optional): A description for this subaccount. Example: Gold tier, billed monthly.
- `metadata` (`string`, optional): Custom data as a stringified JSON object. Example: {"order_id": "1001"}
- `primary_contact_email` (`string`, optional): A contact email for the subaccount. Example: partner@example.com.
- `primary_contact_name` (`string`, optional): The name of the contact person for this subaccount. Example: Chidi Okafor.
- `primary_contact_phone` (`string`, optional): A phone number to call for this subaccount. Example: +2348012345679.

Example input: `{"account_number":"<account_number>","business_name":"<business_name>","percentage_charge":18.2,"settlement_bank":"<settlement_bank>"}`

### `paystack_subscription_create`

Create Subscription · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer` (`string`, required): Customer's email address or customer code. Example: CUS_xnxdt6s1zg1f4nx.
- `plan` (`string`, required): Plan code. Example: PLN_gx2wn530m0i3w3m.
- `authorization` (`string`, optional): 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_date` (`string`, optional): 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.

Example input: `{"customer":"<customer>","plan":"<plan>"}`

### `paystack_subscription_enable`

Enable Subscription · Write

Re-enable a disabled subscription.
Returns status and message.
Use paystack_subscription_enable to resume a cancelled subscription.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `code` (`string`, required): Subscription code (SUB_...). Example: SUB_vsyqdmlzble3uii.
- `token` (`string`, required): The subscription's email_token from paystack_subscription_get. Example: d7gofp6yppn3qz7.

Example input: `{"code":"<code>","token":"<token>"}`

### `paystack_subscription_manage_link_get`

Get Subscription Manage Link · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Subscription code (SUB_...). Example: SUB_vsyqdmlzble3uii.

Example input: `{"code":"<code>"}`

### `paystack_transaction_charge_authorization`

Charge Authorization · Write

Charge a customer's saved, reusable authorization (card or direct debit) without them present.
Returns data with the transaction status, reference and amount.
Use paystack_transaction_charge_authorization for repeat or scheduled charges. Get authorization_code from paystack_transaction_verify.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount` (`integer`, required): 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_code` (`string`, required): Valid authorization code to charge. Example: AUTH_72btv547.
- `email` (`string`, required): Customer's email address. Example: customer@example.com.
- `bearer` (`string`, optional): The bearer of the transaction charge. Example: account. One of: `account`, `subaccount`.
- `currency` (`string`, optional): Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN. One of: `GHS`, `KES`, `NGN`, `ZAR`, `USD`.
- `metadata` (`string`, optional): Custom data as a stringified JSON object. Example: {"order_id": "1001"}
- `queue` (`boolean`, optional): If you are making a scheduled charge call, it is a good idea to queue them so the processing system does not get overloaded causing transaction processing errors. Example: false.
- `reference` (`string`, optional): Unique transaction reference. Only -, ., = and alphanumeric characters allowed. Example: sk-order-1001.
- `split_code` (`string`, optional): The split code of the transaction split. Example: SPL_98WF13Eb3w.
- `subaccount` (`string`, optional): The code for the subaccount that owns the payment. Example: ACCT_8f4s1eq7ml6rlzj.
- `transaction_charge` (`string`, optional): A flat fee to charge the subaccount for a transaction. This overrides the split percentage set when the subaccount was created. Example: 10000.

Example input: `{"amount":500000,"authorization_code":"<authorization_code>","email":"<email>"}`

### `paystack_transaction_initialize`

Initialize Transaction · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount` (`integer`, required): 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.
- `email` (`string`, required): Customer's email address. Example: customer@example.com.
- `bearer` (`string`, optional): The bearer of the transaction charge. Example: account. One of: `account`, `subaccount`.
- `callback_url` (`string`, optional): 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.
- `channels` (`array`, optional): Payment channels to offer, any of card, bank, apple_pay, ussd, qr, mobile_money, bank_transfer, eft. Example: ["card", "bank_transfer"]
- `currency` (`string`, optional): Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN. One of: `GHS`, `KES`, `NGN`, `ZAR`, `USD`.
- `invoice_limit` (`integer`, optional): Number of times to charge customer during subscription to plan. Example: 12.
- `label` (`string`, optional): Used to replace the email address shown on the Checkout. Example: Acme Store.
- `metadata` (`object`, optional): Custom data as a JSON object. Example: {"order_id": "1001"}
- `plan` (`string`, optional): 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.
- `reference` (`string`, optional): Unique transaction reference. Only -, ., = and alphanumeric characters allowed. Example: sk-order-1001.
- `split_code` (`string`, optional): The split code of the transaction split. Example: SPL_98WF13Eb3w.
- `subaccount` (`string`, optional): The code for the subaccount that owns the payment. Example: ACCT_8f4s1eq7ml6rlzj.
- `transaction_charge` (`string`, optional): A flat fee to charge the subaccount for a transaction. This overrides the split percentage set when the subaccount was created. Example: 10000.

Example input: `{"amount":500000,"email":"<email>"}`

### `paystack_transaction_partial_debit`

Partial Debit · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount` (`integer`, required): 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_code` (`string`, required): Valid authorization code to charge. Example: AUTH_72btv547.
- `currency` (`string`, required): Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN. One of: `GHS`, `KES`, `NGN`, `ZAR`, `USD`.
- `email` (`string`, required): Customer's email address. Example: customer@example.com.
- `at_least` (`string`, optional): Minimum amount to charge, in the currency's smallest unit. Example: 100000.
- `reference` (`string`, optional): Unique transaction reference. Only -, ., = and alphanumeric characters allowed. Example: sk-order-1001.

Example input: `{"amount":500000,"authorization_code":"<authorization_code>","currency":"GHS","email":"<email>"}`

### `paystack_transfer_finalize`

Finalize Transfer · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `otp` (`string`, required): OTP sent to business phone to verify transfer. Example: 928783.
- `transfer_code` (`string`, required): The transfer code you want to finalize. Example: TRF_vsyqdmlzble3uii.

Example input: `{"otp":"<otp>","transfer_code":"<transfer_code>"}`

### `paystack_transfer_initiate`

Initiate Transfer · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount` (`integer`, required): 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.
- `recipient` (`string`, required): The transfer recipient's code. Example: RCP_t0ya41mp35flk40.
- `reference` (`string`, required): Unique reference (lowercase letters, digits, - and _) that makes the request idempotent. Example: sk-order-1001.
- `source` (`string`, required): Source of funds; only balance is supported. Example: balance.
- `currency` (`string`, optional): Currency of the transfer: NGN, ZAR, KES or GHS. Example: NGN. One of: `NGN`, `ZAR`, `KES`, `GHS`.
- `reason` (`string`, optional): The reason or narration for the transfer. Example: Vendor payout.

Example input: `{"amount":500000,"recipient":"<recipient>","reference":"<reference>","source":"<source>"}`

### `paystack_transfer_recipient_create`

Create Transfer Recipient · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `account_number` (`string`, required): Recipient's bank account number. Example: 0001234567.
- `bank_code` (`string`, required): Bank code from paystack_banks_list. Example: 058.
- `name` (`string`, required): The recipient's name according to their account registration. Example: Monthly Gold.
- `type` (`string`, required): Recipient type: nuban (Nigerian bank), ghipss (Ghana bank), mobile_money, basa (South African bank) or authorization. Example: nuban. One of: `nuban`, `ghipss`, `mobile_money`, `basa`, `authorization`.
- `authorization_code` (`string`, optional): An authorization code from a previous transaction. Example: AUTH_72btv547.
- `currency` (`string`, optional): Three-letter currency code: NGN, GHS, ZAR, KES or USD. Example: NGN.
- `description` (`string`, optional): A description for this recipient. Example: Gold tier, billed monthly.
- `metadata` (`object`, optional): Custom data as a stringified JSON object. Example: {"vendor_id": "V-77"}

Example input: `{"account_number":"<account_number>","bank_code":"<bank_code>","name":"<name>","type":"nuban"}`

### `paystack_transfer_recipient_update`

Update Transfer Recipient · Write

Update a transfer recipient's name or email.
Returns status and message.
Use paystack_transfer_recipient_update to correct recipient details.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Recipient ID or code (RCP_...). Example: RCP_t0ya41mp35flk40.
- `email` (`string`, optional): Recipient's email address. Example: customer@example.com.
- `name` (`string`, optional): Recipient's name. Example: Acme Supplies Ltd.

Example input: `{"code":"<code>"}`

### `paystack_authorization_deactivate`

Deactivate Authorization · Destructive

Deactivate a saved authorization so it can no longer be charged.
Returns status and message.
Use paystack_authorization_deactivate when a customer removes a saved card.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `authorization_code` (`string`, required): Authorization code to be deactivated. Example: AUTH_72btv547.

Example input: `{"authorization_code":"<authorization_code>"}`

### `paystack_subscription_disable`

Disable Subscription · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `code` (`string`, required): Subscription code (SUB_...). Example: SUB_vsyqdmlzble3uii.
- `token` (`string`, required): The subscription's email_token from paystack_subscription_get. Example: d7gofp6yppn3qz7.

Example input: `{"code":"<code>","token":"<token>"}`

### `paystack_transfer_recipient_delete`

Delete Transfer Recipient · Destructive

Delete (deactivate) a transfer recipient.
Returns status and message.
Use paystack_transfer_recipient_delete to stop paying a beneficiary.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Recipient ID or code (RCP_...). Example: RCP_t0ya41mp35flk40.

Example input: `{"code":"<code>"}`

## Related

Other Accounting & Finance connectors ([all 82](/agentkit/connectors/?category=accounting-finance)):

- [QuickBooks](/agentkit/connectors/quickbooks/): Scalekit connector, OAuth, 117 tools
- [Xero](/agentkit/connectors/xero/): Scalekit connector, OAuth, 94 tools
- [Stripe](/agentkit/connectors/stripe/): Scalekit connector, Access token, 178 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
