Skip to main content
Paystack logo
  • Category: payment processing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 112
  • Triggers: 0
  • Slug: PAYSTACK
  • Version: 20261101_00

Tools

Slug: PAYSTACK_ADD_PRODUCTS_TO_PAGETool to add products to a Paystack payment page. Use when you need to add products to an existing page that was created with ‘product’ type. This action adds the specified products to the page, allowing customers to select from multiple products when making a payment.

Input Parameters

string
required
The ID or slug of the payment page. Only pages created with ‘product’ type can have products added.
array
required
List of product IDs to add to the payment page. Each product must already exist in your Paystack account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_ADD_PRODUCTS_TO_STOREFRONTTool to add previously created products to a Storefront. Use when you need to associate existing products with a specific storefront.

Input Parameters

integer
required
The unique identifier of the Storefront
array
required
An array of product IDs to add to the storefront

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_ADD_SPLIT_CODE_TO_VIRTUAL_TERMINALTool to add a split code to a virtual terminal. Use when you need to assign payment splitting configuration to a virtual terminal.

Input Parameters

string
required
Code of the Virtual Terminal to update
string
required
The split code to assign to the virtual terminal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_ADD_SUBACCOUNT_TO_SPLITTool to add a subaccount to a split configuration, or update the share of an existing subaccount. Use this when you need to modify the payment distribution by adding new partners/customers to a split or adjusting their allocation. The split must already exist before adding subaccounts to it.

Input Parameters

integer
required
The ID of the split configuration to update
integer
required
The percentage or flat quota allocated to this subaccount. The value depends on the split type (percentage vs flat amount).
string
required
Subaccount code of the customer or partner to add to the split. This code starts with ‘ACCT_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_ARCHIVE_PAYMENT_REQUESTTool to archive a payment request to clean up records. Use when you need to remove a payment request from active listings. An archived payment request cannot be verified and will not appear when listing payment requests.

Input Parameters

integer
required
The unique identifier of a previously created payment request. Once archived, the payment request cannot be verified and will not be returned when listing payment requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_ASSIGN_DESTINATION_TO_VIRTUAL_TERMINALTool to assign WhatsApp destinations to a Virtual Terminal for payment notifications. Use when you need to add recipients who will receive notifications for payments made through a specific Virtual Terminal.

Input Parameters

string
required
Code of the Virtual Terminal to assign destinations to
array
required
Array of destination objects containing recipients for payment notifications. Each destination must have a name and WhatsApp number (target)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CHECK_PENDING_CHARGETool to check the status of a pending charge transaction. Use when you receive a ‘pending’ status from a charge endpoint or need to verify if a charge status has changed. Wait at least 10 seconds after initiating a charge before calling this endpoint.

Input Parameters

string
required
The reference of the ongoing transaction to check

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CHECK_SLUG_AVAILABILITYTool to check if a custom slug is available for use when creating a payment page. Use when you need to verify a slug is not already taken before creating a new payment page.

Input Parameters

string
required
The custom slug to check for availability. Used when creating a payment page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_BULK_TRANSFER_RECIPIENTCreate multiple transfer recipients in batches. Use when you need to add multiple recipients at once for transfers. Duplicate account numbers automatically return existing recipient records instead of creating duplicates.

Input Parameters

array
required
Array of recipient objects to create in bulk. Each object must contain type, name, account_number, and bank_code. Duplicate account numbers will return the existing recipient record instead of creating a new one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_CHARGETool to initiate a payment by integrating the payment channel of your choice. Use when you need to charge a customer using authorization code, bank account, mobile money, or USSD.

Input Parameters

string
Customer’s 4-digit PIN (required for local cards in some countries)
object
Bank account details for bank charge.
object
USSD details for USSD charge.
string
required
Customer’s email address (required)
integer
required
Amount in subunit of the currency (e.g., kobo for NGN, pesewas for GHS, cents for ZAR). For example, 10000 kobo = 100 NGN
string
Customer’s birthday in YYYY-MM-DD format (required for some payment channels)
object
Custom metadata object for storing additional transaction information
string
Device ID for fraud detection
string
Unique transaction reference. If not provided, Paystack will generate one
object
Mobile money details for mobile money charge.
string
Authorization code for recurring charges. Use this to charge a customer using a previously saved authorization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_CUSTOMERTool to create a customer on your Paystack integration. Use when you need to add a new customer with their email address and optional details like name and phone number.

Input Parameters

string
required
Customer’s email address (required)
string
Customer’s phone number
object
Custom metadata object for storing additional customer information
string
Customer’s last name
string
Customer’s first name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_PAYMENT_PAGETool to create a payment page on your Paystack integration. Use when you need to create a payment page that customers can visit to make payments.

Input Parameters

string
required
Name of the payment page
string
The ID of the plan to subscribe customers on this payment page to when type is set to subscription
string
URL slug you would like to be associated with this page. Page will be accessible at https://paystack.com/pay/[slug]
string ("payment" | "subscription" | "product" | "plan")
Type options for payment pages.
integer
Amount for the page in subunit (kobo if currency is NGN, pesewas if currency is GHS, and cents if currency is ZAR). If omitted, customer can enter the amount.
string ("NGN" | "GHS" | "ZAR" | "KES" | "USD")
Currency options for payment pages.
object
JSON object of custom data
string
The split code of the transaction split. e.g. SPL_98WF13Eb3w
string
Description of the payment page
boolean
Specifies whether to collect a fixed amount on the payment page. If true, amount must be passed.
string
If you would like Paystack to redirect to a URL upon successful payment, specify the URL here
boolean
Specify whether to collect phone numbers on the payment page
array
If you would like to accept custom fields, specify them here
string
A success message to display to the customer after a successful transaction
string
An email address that will receive transaction notifications for this payment page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_PAYMENT_REQUESTCreate a new payment request by issuing an invoice to a customer. Use this when you need to request payment from a customer for goods or services.

Input Parameters

array
Array of taxes to apply to the payment request
boolean
Indicate if request should be saved as draft. Defaults to false and overrides send_notification
integer
required
Payment request amount in subunit (e.g., kobo for NGN, cents for USD). Only useful if line_items and tax values are ignored. The endpoint will throw a friendly warning if neither is available.
string ("NGN" | "GHS" | "ZAR" | "USD")
Currency options for payment requests.
string
required
Customer ID or customer code to issue the payment request to
string
ISO 8601 representation of request due date
array
Array of line items for the payment request
string
The split code of the transaction split. This allows you to split the payment with one or more accounts
string
A short description of the payment request
boolean
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
integer
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.
boolean
Indicates whether Paystack sends an email notification to customer. Defaults to true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_PLANTool to create a plan for recurring payments on Paystack. Use when you need to set up subscription billing or recurring payment schedules. The plan defines the amount, interval, and other settings for recurring charges to customers.

Input Parameters

string
required
Name of the plan
integer
required
Amount to charge in subunit (kobo if NGN, pesewas if GHS, cents if ZAR or USD)
string
Currency in which amount is set. Allowed values are NGN, GHS, ZAR or USD
string ("daily" | "weekly" | "monthly" | "biannually" | "annually")
required
Payment interval for recurring charges
boolean
Set to false if you don’t want text messages to be sent to your customers
string
A description for this plan
integer
Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing
boolean
Set to false if you don’t want invoices to be sent to your customers

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_REFUNDTool to initiate a refund for a previously completed transaction on Paystack. Use when a customer requests a refund or when you need to reverse a payment. The refund can be for the full transaction amount or a partial amount.

Input Parameters

integer
Amount to refund in subunit (kobo for NGN, pesewas for GHS, cents for USD/ZAR/KES). If not specified, the full transaction amount will be refunded. Cannot exceed the original transaction amount.
string ("GHS" | "KES" | "NGN" | "USD" | "ZAR")
Supported currencies for Paystack refunds.
string
required
Transaction reference or ID of the previously completed transaction to refund.
string
Note to send to the customer explaining the reason for the refund.
string
Internal note for the merchant’s record. Not visible to the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_SPLITTool to create a split configuration for transaction revenue sharing. Use when you need to configure how transaction revenue should be split between multiple subaccounts (e.g., for marketplace platforms, revenue sharing, or commission distribution).

Input Parameters

string
required
Name for the transaction split configuration
string ("percentage" | "flat")
required
The type of transaction split - ‘percentage’ for percentage-based splits or ‘flat’ for fixed amount splits
string ("NGN" | "GHS" | "ZAR" | "USD" | "KES")
required
The transaction currency for this split configuration
string ("subaccount" | "account" | "all-proportional" | "all")
required
Specifies who bears the Paystack transaction charges. ‘subaccount’ means a specific subaccount bears it, ‘account’ means the main account bears it, ‘all-proportional’ distributes charges proportionally, ‘all’ means all parties share charges
array
required
List of subaccounts with their respective share allocations. Each subaccount specifies the subaccount code and the share amount
string
Subaccount code that will bear the transaction charges. Required only when bearer_type is ‘subaccount’. This subaccount will be charged for the Paystack fees

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_STOREFRONTCreate a digital storefront on Paystack to manage and display products. Use this when you need to set up a new online shop for selling digital or physical products.

Input Parameters

string
required
Name of the storefront
string
required
A unique identifier to access your store. Once the storefront is created, it can be accessed from https://paystack.shop/your-slug
string ("GHS" | "KES" | "NGN" | "USD" | "ZAR")
required
Currency for prices of products in your storefront. Must be one of: GHS, KES, NGN, USD, ZAR
string
The description of the storefront

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_SUBACCOUNTTool to create a subaccount on your Paystack integration. Use when you need to set up a new subaccount with bank details and settlement information.

Input Parameters

string
Stringified JSON object of custom data
string
A description for this subaccount
string
required
Name of business for subaccount
string
required
Bank account number
string
required
Bank code for the bank. You can get the list of Bank Codes by calling the List Banks endpoint.
number
required
Percentage of transaction amount charged by the subaccount
string
The name of the contact person for this subaccount
string
A contact email for the subaccount
string
A phone number to call for this subaccount

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_TRANSFER_RECIPIENTTool to create a new recipient for transfers. Use when you need to set up a recipient before initiating a transfer. Note: A duplicate account number will lead to retrieval of the existing record rather than creating a new one.

Input Parameters

string
required
The recipient’s name according to their account registration. This is the name that will appear on transfer receipts.
string ("nuban" | "ghipss" | "mobile_money" | "basa" | "authorization")
required
Recipient type. Options: ‘nuban’ (Nigerian bank account), ‘ghipss’ (Ghanaian bank account), ‘mobile_money’ (mobile money account), ‘basa’ (South African bank account), ‘authorization’ (Paystack authorization code from previous transaction).
string
Email address of the recipient. Optional but recommended for better record-keeping and communication.
string
Currency for the account receiving the transfer. If not provided, defaults to NGN (Nigerian Naira). Common values: ‘NGN’, ‘GHS’ (Ghanaian Cedi), ‘ZAR’ (South African Rand), ‘USD’.
object
JSON object of custom data. You can store additional information about the recipient here. Maximum of 10 key-value pairs allowed.
string
required
Recipient’s bank code. Required for bank account types. You can get the list of bank codes by calling the List Banks endpoint. For Nigerian banks, this is typically a 3-digit code (e.g., ‘044’ for Access Bank).
string
A description for this recipient. Helpful for identifying the purpose or context of this recipient in your records.
string
required
Recipient’s bank account number. Required for bank account types (nuban, ghipss, basa). Must be a valid account number for the specified bank.
string
An authorization code from a previous transaction. Required when type is ‘authorization’. This allows creating a recipient from a previously authorized payment method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_CREATE_VIRTUAL_TERMINALCreate a Virtual Terminal on your Paystack integration to accept payments. Use this when you need to set up a new payment terminal for in-person or remote transactions with custom notification settings.

Input Parameters

string
required
The name of the virtual terminal
object
Additional custom data as key-value pairs to store with the virtual terminal
string
Split code to associate with the virtual terminal for automatic payment splitting
array
required
Array of recipients who will receive payment notifications for transactions on this Virtual Terminal. Each destination must have a name and target (phone number or email)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_DEACTIVATE_AUTHORIZATIONTool to deactivate an authorization when a card or payment method needs to be forgotten. Use when customers want to remove saved payment methods from their account.

Input Parameters

string
required
Authorization code for the card or payment method to deactivate (e.g., ‘AUTH_56wcbzw51e’). This removes the saved payment method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_DEACTIVATE_VIRTUAL_TERMINALTool to deactivate a Virtual Terminal on your integration. Use when you need to disable a terminal and prevent it from accepting further payments.

Input Parameters

string
required
Code of the Virtual Terminal to deactivate (e.g., ‘VT_MCK5292Z’). This will disable the terminal and prevent it from accepting payments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_DELETE_PRODUCTDelete a previously created product from Paystack by its ID. Use this when you need to remove a product from your catalog. The deletion is permanent and cannot be undone.

Input Parameters

integer
required
The unique identifier of the product to delete. You can obtain product IDs from PAYSTACK_CREATE_PRODUCT, PAYSTACK_UPDATE_PRODUCT, or by listing products.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_DELETE_STOREFRONTDelete a previously created storefront from Paystack by its ID. Use this when you need to remove a storefront. The deletion is permanent and cannot be undone.

Input Parameters

integer
required
The unique identifier of the storefront to delete. You can obtain storefront IDs from PAYSTACK_CREATE_STOREFRONT or by listing storefronts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_DELETE_TRANSFER_RECIPIENTTool to delete a transfer recipient by setting it to inactive status. Use when you need to remove a recipient from the active transfer list.

Input Parameters

string
required
Transfer recipient code to delete (e.g., ‘RCP_5ap8rcimmcj8lbi’). This sets the recipient to inactive status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_DISABLE_OTP_FOR_TRANSFERSTool to disable OTP requirement for programmatic transfers. Use when you want to complete transfers without OTP verification. Returns an OTP needed to finalize the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_DISABLE_SUBSCRIPTIONTool to disable a subscription on your Paystack integration. Use when you need to stop recurring charges for a customer subscription. Requires the subscription code and email verification token sent to the customer.

Input Parameters

string
required
Subscription code to disable
string
required
Email token sent to the customer for verification

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_DUPLICATE_STOREFRONTTool to duplicate a previously created Storefront. Use when you need to create a copy of an existing storefront with the same configuration.

Input Parameters

integer
required
The unique identifier of the Storefront to duplicate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_ENABLE_OTP_REQUIREMENT_FOR_TRANSFERSTool to enable OTP requirement for transfers. Use when a customer wants to stop being able to complete transfers programmatically and require OTP verification instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_EXPORT_TRANSACTIONSTool to export transactions from Paystack for a specific timeframe. Use when you need to download transaction data for reporting, analysis, or record-keeping purposes. The API returns a download link that expires after a certain time.

Input Parameters

string
The end date for the export range in ISO 8601 format (e.g., 2024-06-30T13:36:54Z). If not provided, exports up to the latest transaction.
string
The start date for the export range in ISO 8601 format (e.g., 2024-06-01T00:00:01Z). If not provided, exports from the earliest transaction.
string ("success" | "failed" | "abandoned" | "reversed" | "all")
Transaction status filter values.
integer
Filter transactions by customer ID (numeric identifier for the customer).
integer
Filter transactions by settlement ID (numeric identifier for the settlement).
string
Filter transactions by subaccount code (e.g., ACCT_dskvlw3y3dMukmt).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_BALANCETool to fetch the available balance on your Paystack integration. Use when you need to check account balance across different currencies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_BALANCE_LEDGERTool to fetch all pay-ins and pay-outs that went into your Paystack balance. Use when you need to view transaction history and balance changes over time.

Input Parameters

string
The end date for filtering ledger entries. Format: YYYY-MM-DD or ISO 8601 timestamp.
string
The start date for filtering ledger entries. Format: YYYY-MM-DD or ISO 8601 timestamp.
integer
The section to retrieve. Use this to navigate through paginated results (e.g., page 1, 2, 3, etc.).
integer
Number of records to fetch per page. Allows you to control pagination size for the ledger results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_BULK_CHARGE_BATCHTool to retrieve a specific bulk charge batch by code. Use when you need to check the progress of a bulk charge batch via its total_charges and pending_charges attributes.

Input Parameters

string
required
The code for the charge whose batches you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_CUSTOMERTool to get details of a customer on your integration. Use when you need to retrieve customer information using their customer code.

Input Parameters

string
required
The code for the customer gotten from the response of the customer creation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_MANDATE_AUTHORIZATIONSFetch direct debit mandate authorizations associated with a customer ID. The response may include pagination metadata; the tool makes a single request and does not retrieve subsequent pages.

Input Parameters

integer
required
The customer ID for the authorizations to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_PAYMENT_PAGETool to fetch details of a payment page on your Paystack integration. Use when you need to retrieve information about a specific payment page by its ID.

Input Parameters

integer
required
The unique identifier of a payment page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_PAYMENT_REQUESTTool to fetch details of a payment request from Paystack. Use when you need to retrieve comprehensive information about a previously created payment request, including customer details, payment status, line items, and associated metadata.

Input Parameters

integer
required
The unique identifier of a previously created payment request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_PAYMENT_SESSION_TIMEOUTTool to fetch the payment session timeout configured on your Paystack integration. Use when you need to check the current timeout duration for payment sessions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_PLANTool to get details of a plan on your integration. Use when you need to retrieve plan information using the plan code or ID.

Input Parameters

string
required
The plan ID or code you want to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_PRODUCTTool to get details of a product on your integration. Use when you need to retrieve product information by its ID.

Input Parameters

integer
required
The unique identifier of the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_PRODUCT_ORDERSFetch orders for a particular product on your Paystack integration by product ID. The response includes pagination metadata.

Input Parameters

integer
required
The unique identifier of the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_REFUNDTool to get details of a refund on your integration. Use when you need to retrieve comprehensive information about a specific refund, including status, amount, customer details, and timestamps.

Input Parameters

integer
required
The identifier of the refund to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_SPLITTool to get details of a split configuration for a transaction. Use when you need to retrieve split payment configuration information by its ID.

Input Parameters

integer
required
The ID of the split configuration to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_STOREFRONTTool to get the details of a previously created Storefront. Use when you need to retrieve information about a specific storefront including its products, contacts, and configuration.

Input Parameters

integer
required
The unique identifier of the Storefront to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_STOREFRONT_ORDERSFetch a page of orders for a Paystack storefront by its ID, with optional pagination.

Input Parameters

integer
required
The unique identifier of the Storefront
integer
The page number to retrieve (for pagination)
integer
The number of records to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_SUBACCOUNTTool to get details of a subaccount on your integration. Use when you need to retrieve subaccount information using the subaccount code.

Input Parameters

string
required
The subaccount code you want to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_SUBSCRIPTIONTool to get details of a subscription on your integration. Use when you need to retrieve subscription information using the subscription code.

Input Parameters

string
required
The subscription code for the subscription you want to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_TRANSACTIONTool to get details of a transaction carried out on your integration. Use when you need to retrieve comprehensive information about a specific transaction, including payment status, customer details, authorization info, and timestamps.

Input Parameters

integer
required
The ID of the transaction to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_TRANSACTION_TIMELINETool to fetch the timeline of a transaction showing the steps taken from initiation to completion. Use when you need to debug payment flows or understand where customers encountered issues during the payment process.

Input Parameters

integer
required
The ID of the transaction to fetch the timeline for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_TRANSFER_RECIPIENTTool to fetch details of a transfer recipient. Use when you need to retrieve information about an existing recipient using their recipient code.

Input Parameters

string
required
The transfer recipient code obtained when the recipient was created. This unique code identifies the recipient in your integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FETCH_VIRTUAL_TERMINALTool to fetch a Virtual Terminal on your Paystack integration. Use when you need to retrieve details about an existing virtual terminal, including its configuration, payment methods, and active status.

Input Parameters

string
required
Code of the Virtual Terminal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_FINALIZE_PAYMENT_REQUESTTool to finalize the creation of a draft payment request for a customer. Use when you need to convert a draft payment request into an active one that can be paid by the customer.

Input Parameters

integer
required
The unique identifier of a draft payment request to finalize

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_GET_PAYMENT_REQUEST_TOTALSTool to retrieve metrics for all pending and successful payment requests. Use when you need an overview of payment request amounts grouped by currency and status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_GET_TRANSACTION_TOTALSTool to get the total amount received on your Paystack account. Use when you need to retrieve transaction totals and pending transfers, optionally filtered by date range.

Input Parameters

string
The end date for the totals calculation in ISO 8601 format (e.g., 2024-06-30T13:36:54Z). If not provided, calculates up to the latest transaction.
string
The start date for the totals calculation in ISO 8601 format (e.g., 2024-06-01T00:00:01Z). If not provided, calculates from the earliest transaction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_INITIALIZE_AUTHORIZATIONTool to initialize a reusable authorization for recurring transactions. Use when you need to create a direct debit mandate that allows charging a customer’s account repeatedly without requiring them to provide payment details each time.

Input Parameters

string
required
Customer’s email address for the authorization
object
Customer’s bank account details for direct debit authorization.
object
Customer’s address information for authorization.
string ("direct_debit")
required
Authorization channel. Currently only direct_debit is supported for creating reusable authorizations
string
Fully qualified URL (e.g. https://example.com/) to redirect the customer to after authorization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_INITIALIZE_TRANSACTIONTool to initialize a transaction from your backend. Returns an authorization URL to redirect the customer to for payment. Use when you need to start a payment flow and get a checkout URL for the customer.

Input Parameters

string
If transaction is to create a subscription to a predefined plan, provide plan code here. This would invalidate the value provided in amount
string
required
Customer’s email address (required)
string
Used to replace the email address shown on the Checkout form
object
Split configuration for transactions.
integer
required
Amount should be in the smallest denomination of the currency (subunit). For example, 10000 kobo = 100 NGN, 10000 pesewas = 100 GHS
string ("account" | "subaccount")
Who bears the transaction charge.
array
An array of payment channels to control what channels you want to make available to the user to make a payment with
string ("GHS" | "KES" | "NGN" | "ZAR" | "USD")
Supported currencies for Paystack transactions.
object
JSON object of custom data to include with the transaction
string
Unique transaction reference. Only alphanumeric characters, hyphens, periods, and equals signs allowed. If not provided, Paystack will generate one
string
The split code of the transaction split. Use this to split payment between multiple accounts
string
The code for the subaccount that owns the payment. This overrides the split configuration if provided
string
Fully qualified URL to redirect the customer to after a successful payment. Use this to override the callback URL provided on the dashboard for this transaction
integer
Number of times to charge customer during subscription to plan
integer
A flat fee to charge the subaccount for this transaction in subunit. This overrides the split percentage set when the subaccount was created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_INITIATE_BULK_CHARGETool to initiate a bulk charge on your integration. Use when you need to charge multiple customers at once using their authorization codes.

Input Parameters

array
required
Array of charge objects with authorization, amount, and optional reference. Each object represents a charge to be processed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_BANKSTool to get a list of all supported banks and their properties on Paystack. Use when you need to retrieve available banks for payments, transfers, or account verification.

Input Parameters

string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
integer
The offset to retrieve data from (page number)
string ("ghipps" | "mobile_money" | "nuban" | "kepss" | "basa")
Types of financial channels.
string ("ghana" | "kenya" | "nigeria" | "south africa")
Supported countries for bank listings.
string ("emandate" | "digitalbankmandate")
Gateway types for Nigerian banks.
integer
The number of records to fetch per request
string ("GHS" | "KES" | "NGN" | "ZAR")
Supported currencies for bank listings.
string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
boolean
A flag to indicate if cursor based pagination should be used
boolean
A flag to filter for banks a customer can pay directly from
boolean
A flag that returns Nigerian banks with their NIP institution code. The returned value can be used in identifying institutions on NIP.
boolean
A flag to filter for available banks a customer can make a transfer to complete a payment
boolean
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_BULK_CHARGE_BATCHESTool to list bulk charge batches created on your integration. Use when you need to view all bulk charge batches, optionally filtering by status (active, paused, or complete) and paginating through results.

Input Parameters

integer
The page number to retrieve. Use this to navigate through paginated results.
string ("active" | "paused" | "complete")
Status filter options for bulk charge batches.
integer
Number of records to fetch per page. Controls pagination size for the batch results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_CHARGES_IN_BATCHTool to retrieve the charges associated with a specified bulk charge batch. Use when you need to inspect individual charge details within a batch to monitor charge statuses or retrieve charge-level information.

Input Parameters

string
required
The batch code for the bulk charge whose charges you want to retrieve
integer
The offset to retrieve data from (page number)
string ("success" | "failed" | "pending" | "error" | "inactive_authorization")
Status values for filtering charges.
integer
Number of records to fetch per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_COUNTRIESTool to retrieve a list of countries that Paystack currently supports. Use when you need to know which countries are available for Paystack operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_CUSTOMERSTool to list customers available on your integration. Use when you need to retrieve all customers with optional filtering by date range and pagination support.

Input Parameters

string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
string
The offset to retrieve data from (page number)
string
The number of records to fetch per request
string
The end date for filtering customers
string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
string
The start date for filtering customers
boolean
A flag to indicate if cursor based pagination should be used

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_DISPUTESTool to list transaction disputes filed by customers on your Paystack integration. Use when you need to retrieve disputes with optional filtering by status, transaction, or date range.

Input Parameters

string
The end date for filtering disputes (ISO 8601 format or YYYY-MM-DD)
string
The start date for filtering disputes (ISO 8601 format or YYYY-MM-DD)
integer
The section to retrieve (page number)
string ("awaiting-merchant-feedback" | "awaiting-bank-feedback" | "pending" | "resolved")
Status values for dispute filtering.
integer
Number of records to fetch per page
string
Transaction ID to filter disputes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_DOMAINSTool to list all registered Apple Pay domains on your integration. Use when you need to retrieve domains configured for Apple Pay payments.

Input Parameters

string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
boolean
A flag to indicate if cursor based pagination should be used

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_MANDATE_AUTHORIZATIONSTool to get a list of all direct debit mandates on your integration. Use when you need to retrieve mandate authorizations with optional filtering by status and pagination support.

Input Parameters

string
The cursor value of the next set of authorizations to fetch. You can get this from the meta object of the response
string ("pending" | "active" | "revoked")
Status values for mandate authorizations.
integer
The number of authorizations to fetch per request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_ORDERSTool to list orders available on your integration. Use when you need to retrieve all orders with optional filtering by date range and pagination support.

Input Parameters

integer
The section to retrieve
string
The end date for filtering orders
integer
Number of records to fetch per page
string
The start date for filtering orders

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_PAYMENT_PAGESTool to list payment pages available on your Paystack integration. Use when you need to retrieve all payment pages with optional filtering by date range and pagination.

Input Parameters

string
The end date in ISO 8601 format (YYYY-MM-DD)
string
The start date in ISO 8601 format (YYYY-MM-DD)
integer
The section to retrieve
integer
Number of records to fetch per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_PAYMENT_REQUESTSTool to list all previously created payment requests to your customers. Use when you need to retrieve a list of payment requests with optional filters for customer, status, currency, or date range.

Input Parameters

string
The end date for filtering payment requests (ISO 8601 format)
string
The start date for filtering payment requests (ISO 8601 format)
integer
The section to retrieve (page number)
string ("draft" | "pending" | "success" | "failed")
Status options for filtering payment requests.
integer
Number of records to fetch per page
string
If your integration supports more than one currency, choose the one to filter by (e.g., NGN, GHS, ZAR, USD)
string
Customer ID to filter payment requests for a specific customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_PLANSList subscription plans on your integration, optionally filtering by interval, amount, or date range. Results are paginated.

Input Parameters

string
Filter plans created up to this date (ISO 8601 format or YYYY-MM-DD).
string
Filter plans created from this date (ISO 8601 format or YYYY-MM-DD).
integer
The page number to retrieve. Use this to navigate through paginated results.
integer
Filter plans by amount in subunit (kobo if NGN, pesewas if GHS, cents if ZAR or USD).
integer
Number of records to fetch per page. Controls pagination size for the plan results.
string ("daily" | "weekly" | "monthly" | "biannually" | "annually")
Plan billing interval options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_PRODUCTSTool to list products available on your integration. Use when you need to retrieve all products with optional filtering by date range, active status, and pagination support.

Input Parameters

integer
The section to retrieve (page number)
boolean
The state of the product - filter by active status
integer
Number of records to fetch per page
string
The end date for filtering products
string
The start date for filtering products

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_REFUNDSTool to list refunds available on your integration. Use when you need to retrieve a list of refunds with optional filters for date range and pagination.

Input Parameters

string
The end date for filtering refunds (ISO 8601 format)
string
The start date for filtering refunds (ISO 8601 format)
integer
The section to retrieve (page number)
integer
Number of records to fetch per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_SETTLEMENTSTool to list settlements made to your settlement accounts. Use when you need to retrieve settlement information with optional pagination support.

Input Parameters

integer
The offset to retrieve data from (page number for pagination).
integer
The number of records to fetch per request. Controls pagination size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_SPLITSList transaction splits on your integration, with optional filtering by name, status, subaccount, or date range and pagination.

Input Parameters

string
The name of the split to filter by
integer
The offset to retrieve data from (page number)
boolean
The status of the split - true for active splits, false for inactive splits
string
The end date for filtering splits
integer
The number of records to fetch per request
string
The start date for filtering splits
string
Filter by subaccount code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_STATES_AVSTool to retrieve a list of states for a country for address verification. Use when you need to get available states/provinces for a specific country code.

Input Parameters

string
required
The country code of the states to list. It is gotten after the charge request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_STOREFRONT_PRODUCTSTool to list all products in a Paystack storefront. Use when you need to retrieve product information for a specific storefront using its ID.

Input Parameters

integer
required
The unique identifier of the Storefront
integer
The page number to retrieve (for pagination)
integer
The number of records to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_STOREFRONTSTool to list storefronts available on your integration. Use when you need to retrieve all storefronts with optional filtering by status and pagination support.

Input Parameters

integer
The offset to retrieve data from. Use this to navigate through paginated results.
string ("active" | "inactive")
Storefront status options.
integer
Number of records to fetch per request. Controls pagination size for the storefront results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_SUBACCOUNTSTool to list subaccounts available on your integration. Use when you need to retrieve all subaccounts with optional filtering by active status and pagination support.

Input Parameters

integer
The offset to retrieve data from
boolean
Filter by the state of the subaccounts
integer
Number of records to fetch per request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_SUBSCRIPTIONSTool to list all subscriptions available on your integration. Use when you need to retrieve subscriptions, optionally filtering by plan, customer, or date range.

Input Parameters

string
Filter subscriptions created up to this date (ISO 8601 format or YYYY-MM-DD).
string
Filter subscriptions created from this date (ISO 8601 format or YYYY-MM-DD).
integer
The page number to retrieve. Use this to navigate through paginated results.
integer
Filter subscriptions by plan ID. Use this to retrieve subscriptions for a specific plan.
integer
Number of records to fetch per page. Controls pagination size for the subscription results.
string
Filter subscriptions by customer ID. Use this to retrieve subscriptions for a specific customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_TRANSACTIONSList transactions on your integration with optional filters including date range, status, source, channel and customer. Supports cursor-based and page-based pagination to retrieve transactions in batches.

Input Parameters

string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
integer
The offset to retrieve data from
integer
Filter transactions by a specific amount
string ("merchantApi" | "checkout" | "pos" | "virtualTerminal")
Transaction source values.
string ("success" | "failed" | "abandoned" | "reversed")
Transaction status values.
string ("card" | "pos" | "bank" | "dedicated_nuban" | "ussd" | "bank_transfer")
Payment channel values.
string
The end date for filtering transactions
integer
The number of records to fetch per request
string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
string
The start date for filtering transactions
integer
The settlement ID to filter for settled transactions
string
Filter transaction by split code
boolean
A flag to indicate if cursor based pagination should be used
string
Filter transactions by a terminal ID
string
Filter transactions by a customer code
string
Filter transaction by subaccount code
string
Filter transactions by a virtual account number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_TRANSFER_RECIPIENTSTool to list transfer recipients available on your integration. Use when you need to retrieve all recipients with optional pagination support.

Input Parameters

string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
integer
The offset to retrieve data from
integer
The number of records to fetch per request
string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
boolean
A flag to indicate if cursor based pagination should be used

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_TRANSFERSTool to list all transfers carried out on your integration. Use when you need to retrieve transfer history with optional filtering by status, recipient, or date range.

Input Parameters

string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
integer
The offset to retrieve data from (page number)
string ("pending" | "success" | "failed" | "otp" | "abandoned" | "reversed" | "blocked" | "rejected" | "received")
Transfer status filter options.
string
The end date for filtering transfers (YYYY-MM-DD format)
integer
The number of records to fetch per request
string
An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
string
The start date for filtering transfers (YYYY-MM-DD format)
string
Filter transfer by the recipient code
boolean
A flag to indicate if cursor based pagination should be used

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_LIST_VIRTUAL_TERMINALSTool to list virtual terminals available on your integration. Use when you need to retrieve all virtual terminals with pagination support.

Input Parameters

integer
The offset to retrieve data from. Use this to navigate through paginated results.
integer
The number of records to fetch per request. Controls pagination size for the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_PAUSE_BULK_CHARGETool to pause processing of a bulk charge batch. Use when you need to temporarily stop a bulk charge batch from processing further charges.

Input Parameters

string
required
The batch code for the bulk charge you want to pause

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_PUBLISH_STOREFRONTTool to make a Storefront publicly available on Paystack. Use this when you need to publish a previously created storefront so that customers can access and purchase from it.

Input Parameters

integer
required
The unique identifier of the Storefront to publish. You can obtain storefront IDs from PAYSTACK_CREATE_STOREFRONT or by listing storefronts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_REMOVE_SUBACCOUNT_FROM_SPLITTool to remove a subaccount from a split configuration. Use this when you need to stop payment distribution to a specific partner or customer in an existing split. The share parameter must match the subaccount’s current allocation.

Input Parameters

integer
required
The ID of the split configuration to update
integer
required
The share amount currently allocated to this subaccount in the split. This value must match the subaccount’s current share allocation.
string
required
Subaccount code of the customer or partner to remove from the split. This code starts with ‘ACCT_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_RESEND_OTP_FOR_TRANSFERTool to resend OTP for a transfer. Use when a customer is having trouble receiving their OTP and needs a new one sent to complete their transfer.

Input Parameters

string ("disable_otp" | "transfer")
required
Specify the flag to indicate the purpose of the OTP. Valid values are ‘disable_otp’ or ‘transfer’
string
required
The transfer code that requires an OTP validation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_RESOLVE_CARD_BINTool to get basic information about a card BIN (Bank Identification Number). Use when you need to retrieve card details such as brand, issuing bank, country, and card type from the first 6 digits of a card.

Input Parameters

integer
required
The card bank identification number (first 6 digits of the card)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_RESUME_BULK_CHARGE_BATCHTool to resume processing of a previously paused bulk charge batch. Use when you need to restart a paused bulk charge batch using its batch code.

Input Parameters

string
required
The batch code for the bulk charge you want to resume

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_SEND_PAYMENT_REQUEST_NOTIFICATIONTool to send an email notification to a customer for a previously created payment request. Use when you need to remind a customer about an unpaid invoice or payment request.

Input Parameters

integer
required
The unique identifier of a previously created payment request. This action will trigger an email reminder to the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_SET_RISK_ACTIONTool to set a customer’s risk action by whitelisting or blacklisting them. Use when you need to apply fraud prevention rules to a specific customer by setting their risk action to ‘allow’ (whitelist), ‘deny’ (blacklist), or ‘default’ (no special action).

Input Parameters

string
required
Customer code or email address to set risk action for
string ("allow" | "deny" | "default")
Risk action types that can be applied to a customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_SUBMIT_PHONETool to submit phone number when requested during a charge transaction. Use this when a charge requires phone number submission for verification or authentication purposes.

Input Parameters

string
required
Customer’s mobile phone number
string
required
The reference of the ongoing transaction

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_TRIGGER_DIRECT_DEBIT_ACTIVATION_CHARGETool to trigger an activation charge on an inactive direct debit mandate for a customer. Use when a mandate needs to be reactivated or retried.

Input Parameters

integer
required
The customer ID attached to the authorization. This identifies the customer whose direct debit mandate needs activation.
integer
required
The authorization ID obtained from the direct debit initiation response. This identifies the specific mandate to activate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UNASSIGN_DESTINATION_FROM_VIRTUAL_TERMINALTool to unassign WhatsApp destinations from a Virtual Terminal. Use when you need to remove recipients who should no longer receive payment notifications for a specific Virtual Terminal.

Input Parameters

string
required
Code of the Virtual Terminal to unassign destinations from
array
required
Array of WhatsApp numbers in international format (E.164) to unassign from the Virtual Terminal, e.g., +2548012345678

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UNREGISTER_APPLE_PAY_DOMAINTool to unregister a top-level domain or subdomain previously used for Apple Pay integration. Use when you need to remove a domain from your Apple Pay configuration.

Input Parameters

string
required
The domain name or subdomain to unregister from Apple Pay integration. Must be a previously registered domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UPDATE_CUSTOMERTool to update a customer’s details on your Paystack integration. Use when you need to modify existing customer information such as name, phone number, or metadata.

Input Parameters

string
required
The code for the customer gotten from the response of the customer creation
string
Customer’s phone number
string
Stringified JSON object of custom data
string
Customer’s last name
string
Customer’s first name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UPDATE_PAYMENT_PAGETool to update a payment page on your Paystack integration. Use when you need to modify details of an existing payment page such as name, description, amount, or active status.

Input Parameters

integer
required
The unique identifier of the payment page to update
string
Name of the payment page
boolean
Set to false to deactivate page url
integer
Amount should be in the subunit of the currency (kobo if currency is NGN, pesewas if currency is GHS, and cents if currency is ZAR)
string
The description of the page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UPDATE_PAYMENT_REQUESTTool to update a payment request on your Paystack integration. Use when you need to modify details of an existing payment request such as amount, description, due date, or other attributes.

Input Parameters

integer
required
The unique identifier of a previously created payment request
array
Array of taxes to apply to the payment request
boolean
Indicate if request should be saved as draft. Defaults to false and overrides send_notification
integer
Payment request amount in subunit (e.g., kobo for NGN, cents for USD). Only useful if line_items and tax values are ignored. The endpoint will throw a friendly warning if neither is available.
string ("NGN" | "GHS" | "ZAR" | "USD")
Currency options for payment requests.
string
Customer id or code
string
ISO 8601 representation of request due date
array
Array of line items for the payment request
string
The split code of the transaction split. This allows you to split the payment with one or more accounts
string
A short description of the payment request
boolean
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
integer
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.
boolean
Indicates whether Paystack sends an email notification to customer. Defaults to true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UPDATE_PAYMENT_SESSION_TIMEOUTTool to update the payment session timeout on your Paystack integration. Use when you need to change the duration before a payment session expires.

Input Parameters

integer
required
Timeout before canceling session in seconds. Valid range is 60-3600 seconds (1 minute to 1 hour). Set to 0 to disable session timeouts entirely.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UPDATE_PLANTool to update a plan’s details on your Paystack integration. Use when you need to modify an existing plan’s name, amount, interval, or other settings. Only the fields you provide will be updated; other fields remain unchanged.

Input Parameters

string
required
The plan code you want to update
string
Name of the plan
integer
Amount to charge in subunit (kobo if currency is NGN, pesewas if currency is GHS, cents if currency is ZAR or USD)
string ("NGN" | "GHS" | "ZAR" | "USD")
Supported currencies for plans
string ("daily" | "weekly" | "monthly" | "biannually" | "annually")
Interval for recurring payments
boolean
Set to false if you don’t want text messages to be sent to your customers
string
A description for this plan
integer
Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing
boolean
Set to false if you don’t want invoices to be sent to your customers

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UPDATE_PRODUCTTool to update a product on your integration. Use when you need to modify product details like name, description, price, or currency.

Input Parameters

integer
required
The unique identifier of the product to update
string
Name of product
integer
Price should be in kobo if currency is NGN, pesewas if currency is GHS, and cents if currency is ZAR
string ("NGN" | "GHS" | "ZAR" | "USD")
Supported currency codes for Paystack products.
object
JSON object of custom data
integer
Number of products in stock. Use if unlimited is false
boolean
Set to true if the product has unlimited stock. Leave as false if the product has limited stock
string
The split code if sharing the transaction with partners
string
The description of the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UPDATE_SPLITTool to update a split configuration for transactions. Use when you need to modify split settings such as name, active status, or bearer type.

Input Parameters

string
required
The ID or code of the split configuration to update
string
Name of the transaction split
boolean
Toggle status of split. When true, the split is active, else it’s inactive
string ("subaccount" | "account" | "all-proportional" | "all")
Who bears the Paystack transaction charges.
string
Subaccount code that will bear the transaction charges. This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UPDATE_STOREFRONTTool to update the details of a previously created Storefront. Use when you need to modify storefront information such as name, description, or slug.

Input Parameters

integer
required
The unique identifier of the Storefront to update
string
Name of the storefront
string
A unique identifier to access your store. Once the storefront is created, it can be accessed from https://paystack.shop/your-slug
string
The description of the storefront

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UPDATE_SUBACCOUNTTool to update a subaccount’s details on your Paystack integration. Use when you need to modify existing subaccount information such as business name, bank details, contact information, or activation status.

Input Parameters

string
required
The subaccount code you want to update
boolean
Activate or deactivate a subaccount
string
Stringified JSON object of custom data
string
A description for this subaccount
string
Name of business for subaccount
string
Bank account number
string
Bank code for the bank. You can get the list of Bank Codes by calling the List Banks endpoint.
number
Percentage of transaction amount charged by the subaccount
string
The name of the contact person for this subaccount
string
A contact email for the subaccount
string
A phone number to call for this subaccount

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_UPDATE_TRANSFER_RECIPIENTTool to update the details of a transfer recipient. Use when you need to modify an existing recipient’s name or email address.

Input Parameters

string
required
The transfer recipient code obtained when the recipient was created. This unique code identifies the recipient to be updated.
string
The recipient’s name according to their account registration. This is the name that will appear on transfer receipts.
string
Email address of the recipient. Optional but recommended for better record-keeping and communication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_VALIDATE_BANK_ACCOUNTTool to validate the authenticity of a customer’s bank account before sending money. Use when you need to confirm account details are correct and the account is active and can receive funds.

Input Parameters

string
required
The bank code of the customer’s bank (required). You can fetch the bank codes by using the List Banks endpoint.
string
required
Customer’s first and last name registered with their bank (required)
string ("personal" | "business")
required
The type of the customer’s account number (required)
string
required
The two digit ISO code of the customer’s bank (required)
string ("identityNumber" | "passportNumber" | "businessRegistrationNumber")
required
Customer’s mode of identity (required)
string
required
Customer’s account number (required)
string
Customer’s mode of identity number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_VALIDATE_CUSTOMERTool to validate a customer’s identity on your Paystack integration. Use when you need to verify customer identification details such as BVN and bank account information. The verification happens asynchronously, and Paystack sends a webhook event when verification is complete.

Input Parameters

string
required
Customer’s Bank Verification Number
string
required
The code for the customer gotten from the response of the customer creation
string
required
Predefined types of identification. Typically ‘bank_account’
string
Customer’s identification number
string
required
Two-letter country code of identification issuer
string
required
Bank code. You can get the list of bank codes by calling the List Banks endpoint (https://api.paystack.co/bank)
string
required
Customer’s last name
string
required
Customer’s first name
string
Customer’s middle name
string
required
Customer’s bank account number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_VALIDATE_ORDERTool to validate a pay for me order on Paystack. Use when you need to verify the details and status of a previously created order using its unique order code.

Input Parameters

string
required
The unique code of a previously created order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_VERIFY_PAYMENT_REQUESTTool to verify the status of a previously created payment request on Paystack. Use when you need to check if a payment request has been paid or to retrieve details about a specific payment request using its request code.

Input Parameters

string
required
The payment request code (e.g., PRQ_xxxxx) of a previously created payment request. Note: Despite the parameter name ‘id’, this endpoint requires the request_code string, not the numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_VERIFY_STOREFRONT_SLUGCheck whether a storefront slug is available before creating a storefront. The result identifies the slug as available or taken and may include existing storefront details when it is taken.

Input Parameters

string
required
The custom slug to verify for storefront availability. Used when creating a storefront.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYSTACK_VERIFY_TRANSACTIONTool to confirm the status of a transaction using its reference. Use when you need to verify a payment was successful or check the current state of a transaction after customer completes checkout.

Input Parameters

string
required
The transaction reference to verify

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not