Paystack
paystackNigerian financial technology company that offers payment processing services to businesses in Africa.
Acciones disponibles (112)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Products to PagePAYSTACK_ADD_PRODUCTS_TO_PAGEAcciónTool 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.
PAYSTACK_ADD_PRODUCTS_TO_PAGEAcciónTool 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.
Parámetros de entrada
idstringObligatorioThe ID or slug of the payment page. Only pages created with 'product' type can have products added.
productsinteger[]ObligatorioList of product IDs to add to the payment page. Each product must already exist in your Paystack account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Products to StorefrontPAYSTACK_ADD_PRODUCTS_TO_STOREFRONTAcciónTool to add previously created products to a Storefront. Use when you need to associate existing products with a specific storefront.
PAYSTACK_ADD_PRODUCTS_TO_STOREFRONTAcciónTool to add previously created products to a Storefront. Use when you need to associate existing products with a specific storefront.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the Storefront
productsinteger[]ObligatorioAn array of product IDs to add to the storefront
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Split Code to Virtual TerminalPAYSTACK_ADD_SPLIT_CODE_TO_VIRTUAL_TERMINALAcciónTool to add a split code to a virtual terminal. Use when you need to assign payment splitting configuration to a virtual terminal.
PAYSTACK_ADD_SPLIT_CODE_TO_VIRTUAL_TERMINALAcciónTool to add a split code to a virtual terminal. Use when you need to assign payment splitting configuration to a virtual terminal.
Parámetros de entrada
codestringObligatorioCode of the Virtual Terminal to update
split_codestringObligatorioThe split code to assign to the virtual terminal
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Subaccount to SplitPAYSTACK_ADD_SUBACCOUNT_TO_SPLITAcciónTool 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.
PAYSTACK_ADD_SUBACCOUNT_TO_SPLITAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe ID of the split configuration to update
shareintegerObligatorioThe percentage or flat quota allocated to this subaccount. The value depends on the split type (percentage vs flat amount).
subaccountstringObligatorioSubaccount code of the customer or partner to add to the split. This code starts with 'ACCT_'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive Payment RequestPAYSTACK_ARCHIVE_PAYMENT_REQUESTAcciónTool 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.
PAYSTACK_ARCHIVE_PAYMENT_REQUESTAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Assign Destination to Virtual TerminalPAYSTACK_ASSIGN_DESTINATION_TO_VIRTUAL_TERMINALAcciónTool 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.
PAYSTACK_ASSIGN_DESTINATION_TO_VIRTUAL_TERMINALAcciónTool 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.
Parámetros de entrada
codestringObligatorioCode of the Virtual Terminal to assign destinations to
destinationsobject[]ObligatorioArray of destination objects containing recipients for payment notifications. Each destination must have a name and WhatsApp number (target)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Check Pending ChargePAYSTACK_CHECK_PENDING_CHARGEAcciónTool 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.
PAYSTACK_CHECK_PENDING_CHARGEAcciónTool 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.
Parámetros de entrada
referencestringObligatorioThe reference of the ongoing transaction to check
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Check Slug AvailabilityPAYSTACK_CHECK_SLUG_AVAILABILITYAcciónTool 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.
PAYSTACK_CHECK_SLUG_AVAILABILITYAcciónTool 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.
Parámetros de entrada
slugstringObligatorioThe custom slug to check for availability. Used when creating a payment page.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Bulk Create Transfer RecipientsPAYSTACK_CREATE_BULK_TRANSFER_RECIPIENTAcciónCreate 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.
PAYSTACK_CREATE_BULK_TRANSFER_RECIPIENTAcciónCreate 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.
Parámetros de entrada
batchobject[]ObligatorioArray 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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ChargePAYSTACK_CREATE_CHARGEAcciónTool 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.
PAYSTACK_CREATE_CHARGEAcciónTool 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.
Parámetros de entrada
pinstringCustomer's 4-digit PIN (required for local cards in some countries)
bankobjectBank account details for bank charge.
ussdobjectUSSD details for USSD charge.
emailstringObligatorioCustomer's email address (required)
amountintegerObligatorioAmount in subunit of the currency (e.g., kobo for NGN, pesewas for GHS, cents for ZAR). For example, 10000 kobo = 100 NGN
birthdaystringCustomer's birthday in YYYY-MM-DD format (required for some payment channels)
metadataobjectCustom metadata object for storing additional transaction information
device_idstringDevice ID for fraud detection
referencestringUnique transaction reference. If not provided, Paystack will generate one
mobile_moneyobjectMobile money details for mobile money charge.
authorization_codestringAuthorization code for recurring charges. Use this to charge a customer using a previously saved authorization
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create CustomerPAYSTACK_CREATE_CUSTOMERAcciónTool 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.
PAYSTACK_CREATE_CUSTOMERAcciónTool 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.
Parámetros de entrada
emailstringObligatorioCustomer's email address (required)
phonestringCustomer's phone number
metadataobjectCustom metadata object for storing additional customer information
last_namestringCustomer's last name
first_namestringCustomer's first name
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Payment PagePAYSTACK_CREATE_PAYMENT_PAGEAcciónTool 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.
PAYSTACK_CREATE_PAYMENT_PAGEAcciónTool 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.
Parámetros de entrada
namestringObligatorioName of the payment page
planstringThe ID of the plan to subscribe customers on this payment page to when type is set to subscription
slugstringURL slug you would like to be associated with this page. Page will be accessible at https://paystack.com/pay/[slug]
typestringenumType options for payment pages.
paymentsubscriptionproductplanamountintegerAmount 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.
currencystringenumCurrency options for payment pages.
NGNGHSZARKESUSDmetadataobjectJSON object of custom data
split_codestringThe split code of the transaction split. e.g. SPL_98WF13Eb3w
descriptionstringDescription of the payment page
fixed_amountbooleanSpecifies whether to collect a fixed amount on the payment page. If true, amount must be passed.
redirect_urlstringIf you would like Paystack to redirect to a URL upon successful payment, specify the URL here
collect_phonebooleanSpecify whether to collect phone numbers on the payment page
custom_fieldsobject[]If you would like to accept custom fields, specify them here
success_messagestringA success message to display to the customer after a successful transaction
notification_emailstringAn email address that will receive transaction notifications for this payment page
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Payment RequestPAYSTACK_CREATE_PAYMENT_REQUESTAcciónCreate 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.
PAYSTACK_CREATE_PAYMENT_REQUESTAcciónCreate 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.
Parámetros de entrada
taxobject[]Array of taxes to apply to the payment request
draftbooleanIndicate if request should be saved as draft. Defaults to false and overrides send_notification
amountintegerObligatorioPayment 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.
currencystringenumCurrency options for payment requests.
NGNGHSZARUSDcustomerstringObligatorioCustomer ID or customer code to issue the payment request to
due_datestringISO 8601 representation of request due date
line_itemsobject[]Array of line items for the payment request
split_codestringThe split code of the transaction split. This allows you to split the payment with one or more accounts
descriptionstringA short description of the payment request
has_invoicebooleanSet 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
invoice_numberintegerNumeric 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.
send_notificationbooleanIndicates whether Paystack sends an email notification to customer. Defaults to true
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create PlanPAYSTACK_CREATE_PLANAcciónTool 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.
PAYSTACK_CREATE_PLANAcciónTool 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.
Parámetros de entrada
namestringObligatorioName of the plan
amountintegerObligatorioAmount to charge in subunit (kobo if NGN, pesewas if GHS, cents if ZAR or USD)
currencystringCurrency in which amount is set. Allowed values are NGN, GHS, ZAR or USD
intervalstringObligatorioenumPayment interval for recurring charges
dailyweeklymonthlybiannuallyannuallysend_smsbooleanSet to false if you don't want text messages to be sent to your customers
descriptionstringA description for this plan
invoice_limitintegerNumber of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing
send_invoicesbooleanSet to false if you don't want invoices to be sent to your customers
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create RefundPAYSTACK_CREATE_REFUNDAcciónTool 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.
PAYSTACK_CREATE_REFUNDAcciónTool 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.
Parámetros de entrada
amountintegerAmount 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.
currencystringenumSupported currencies for Paystack refunds.
GHSKESNGNUSDZARtransactionstringObligatorioTransaction reference or ID of the previously completed transaction to refund.
customer_notestringNote to send to the customer explaining the reason for the refund.
merchant_notestringInternal note for the merchant's record. Not visible to the customer.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Split ConfigurationPAYSTACK_CREATE_SPLITAcciónTool 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).
PAYSTACK_CREATE_SPLITAcciónTool 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).
Parámetros de entrada
namestringObligatorioName for the transaction split configuration
typestringObligatorioenumThe type of transaction split - 'percentage' for percentage-based splits or 'flat' for fixed amount splits
percentageflatcurrencystringObligatorioenumThe transaction currency for this split configuration
NGNGHSZARUSDKESbearer_typestringObligatorioenumSpecifies 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
subaccountaccountall-proportionalallsubaccountsobject[]ObligatorioList of subaccounts with their respective share allocations. Each subaccount specifies the subaccount code and the share amount
bearer_subaccountstringSubaccount code that will bear the transaction charges. Required only when bearer_type is 'subaccount'. This subaccount will be charged for the Paystack fees
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create StorefrontPAYSTACK_CREATE_STOREFRONTAcciónCreate 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.
PAYSTACK_CREATE_STOREFRONTAcciónCreate 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.
Parámetros de entrada
namestringObligatorioName of the storefront
slugstringObligatorioA unique identifier to access your store. Once the storefront is created, it can be accessed from https://paystack.shop/your-slug
currencystringObligatorioenumCurrency for prices of products in your storefront. Must be one of: GHS, KES, NGN, USD, ZAR
GHSKESNGNUSDZARdescriptionstringThe description of the storefront
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create SubaccountPAYSTACK_CREATE_SUBACCOUNTAcciónTool to create a subaccount on your Paystack integration. Use when you need to set up a new subaccount with bank details and settlement information.
PAYSTACK_CREATE_SUBACCOUNTAcciónTool to create a subaccount on your Paystack integration. Use when you need to set up a new subaccount with bank details and settlement information.
Parámetros de entrada
metadatastringStringified JSON object of custom data
descriptionstringA description for this subaccount
business_namestringObligatorioName of business for subaccount
account_numberstringObligatorioBank account number
settlement_bankstringObligatorioBank code for the bank. You can get the list of Bank Codes by calling the List Banks endpoint.
percentage_chargenumberObligatorioPercentage of transaction amount charged by the subaccount
primary_contact_namestringThe name of the contact person for this subaccount
primary_contact_emailstringA contact email for the subaccount
primary_contact_phonestringA phone number to call for this subaccount
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Transfer RecipientPAYSTACK_CREATE_TRANSFER_RECIPIENTAcciónTool 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.
PAYSTACK_CREATE_TRANSFER_RECIPIENTAcciónTool 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.
Parámetros de entrada
namestringObligatorioThe recipient's name according to their account registration. This is the name that will appear on transfer receipts.
typestringObligatorioenumRecipient 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).
nubanghipssmobile_moneybasaauthorizationemailstringEmail address of the recipient. Optional but recommended for better record-keeping and communication.
currencystringCurrency 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'.
metadataobjectJSON object of custom data. You can store additional information about the recipient here. Maximum of 10 key-value pairs allowed.
bank_codestringObligatorioRecipient'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).
descriptionstringA description for this recipient. Helpful for identifying the purpose or context of this recipient in your records.
account_numberstringObligatorioRecipient's bank account number. Required for bank account types (nuban, ghipss, basa). Must be a valid account number for the specified bank.
authorization_codestringAn authorization code from a previous transaction. Required when type is 'authorization'. This allows creating a recipient from a previously authorized payment method.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Virtual TerminalPAYSTACK_CREATE_VIRTUAL_TERMINALAcciónCreate 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.
PAYSTACK_CREATE_VIRTUAL_TERMINALAcciónCreate 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.
Parámetros de entrada
namestringObligatorioThe name of the virtual terminal
metadataobjectAdditional custom data as key-value pairs to store with the virtual terminal
split_codestringSplit code to associate with the virtual terminal for automatic payment splitting
destinationsobject[]ObligatorioArray 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)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Deactivate AuthorizationPAYSTACK_DEACTIVATE_AUTHORIZATIONAcciónTool 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.
PAYSTACK_DEACTIVATE_AUTHORIZATIONAcciónTool 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.
Parámetros de entrada
authorization_codestringObligatorioAuthorization code for the card or payment method to deactivate (e.g., 'AUTH_56wcbzw51e'). This removes the saved payment method.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Deactivate Virtual TerminalPAYSTACK_DEACTIVATE_VIRTUAL_TERMINALAcciónTool to deactivate a Virtual Terminal on your integration. Use when you need to disable a terminal and prevent it from accepting further payments.
PAYSTACK_DEACTIVATE_VIRTUAL_TERMINALAcciónTool to deactivate a Virtual Terminal on your integration. Use when you need to disable a terminal and prevent it from accepting further payments.
Parámetros de entrada
codestringObligatorioCode of the Virtual Terminal to deactivate (e.g., 'VT_MCK5292Z'). This will disable the terminal and prevent it from accepting payments.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ProductPAYSTACK_DELETE_PRODUCTAcciónDelete 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.
PAYSTACK_DELETE_PRODUCTAcciónDelete 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the product to delete. You can obtain product IDs from PAYSTACK_CREATE_PRODUCT, PAYSTACK_UPDATE_PRODUCT, or by listing products.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete StorefrontPAYSTACK_DELETE_STOREFRONTAcciónDelete 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.
PAYSTACK_DELETE_STOREFRONTAcciónDelete 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the storefront to delete. You can obtain storefront IDs from PAYSTACK_CREATE_STOREFRONT or by listing storefronts.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Transfer RecipientPAYSTACK_DELETE_TRANSFER_RECIPIENTAcciónTool to delete a transfer recipient by setting it to inactive status. Use when you need to remove a recipient from the active transfer list.
PAYSTACK_DELETE_TRANSFER_RECIPIENTAcciónTool to delete a transfer recipient by setting it to inactive status. Use when you need to remove a recipient from the active transfer list.
Parámetros de entrada
codestringObligatorioTransfer recipient code to delete (e.g., 'RCP_5ap8rcimmcj8lbi'). This sets the recipient to inactive status.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Disable OTP for TransfersPAYSTACK_DISABLE_OTP_FOR_TRANSFERSAcciónTool 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.
PAYSTACK_DISABLE_OTP_FOR_TRANSFERSAcciónTool 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Disable SubscriptionPAYSTACK_DISABLE_SUBSCRIPTIONAcciónTool 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.
PAYSTACK_DISABLE_SUBSCRIPTIONAcciónTool 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.
Parámetros de entrada
codestringObligatorioSubscription code to disable
tokenstringObligatorioEmail token sent to the customer for verification
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Duplicate StorefrontPAYSTACK_DUPLICATE_STOREFRONTAcciónTool to duplicate a previously created Storefront. Use when you need to create a copy of an existing storefront with the same configuration.
PAYSTACK_DUPLICATE_STOREFRONTAcciónTool to duplicate a previously created Storefront. Use when you need to create a copy of an existing storefront with the same configuration.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the Storefront to duplicate.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Enable OTP for TransfersPAYSTACK_ENABLE_OTP_REQUIREMENT_FOR_TRANSFERSAcciónTool to enable OTP requirement for transfers. Use when a customer wants to stop being able to complete transfers programmatically and require OTP verification instead.
PAYSTACK_ENABLE_OTP_REQUIREMENT_FOR_TRANSFERSAcciónTool to enable OTP requirement for transfers. Use when a customer wants to stop being able to complete transfers programmatically and require OTP verification instead.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export TransactionsPAYSTACK_EXPORT_TRANSACTIONSAcciónTool 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.
PAYSTACK_EXPORT_TRANSACTIONSAcciónTool 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.
Parámetros de entrada
tostringThe 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.
fromstringThe 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.
statusstringenumTransaction status filter values.
successfailedabandonedreversedallcustomerintegerFilter transactions by customer ID (numeric identifier for the customer).
settlementintegerFilter transactions by settlement ID (numeric identifier for the settlement).
subaccount_codestringFilter transactions by subaccount code (e.g., ACCT_dskvlw3y3dMukmt).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch BalancePAYSTACK_FETCH_BALANCEAcciónTool to fetch the available balance on your Paystack integration. Use when you need to check account balance across different currencies.
PAYSTACK_FETCH_BALANCEAcciónTool to fetch the available balance on your Paystack integration. Use when you need to check account balance across different currencies.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch balance ledgerPAYSTACK_FETCH_BALANCE_LEDGERAcciónTool 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.
PAYSTACK_FETCH_BALANCE_LEDGERAcciónTool 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.
Parámetros de entrada
tostringThe end date for filtering ledger entries. Format: YYYY-MM-DD or ISO 8601 timestamp.
fromstringThe start date for filtering ledger entries. Format: YYYY-MM-DD or ISO 8601 timestamp.
pageintegerThe section to retrieve. Use this to navigate through paginated results (e.g., page 1, 2, 3, etc.).
perPageintegerNumber of records to fetch per page. Allows you to control pagination size for the ledger results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Bulk Charge BatchPAYSTACK_FETCH_BULK_CHARGE_BATCHAcciónTool 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.
PAYSTACK_FETCH_BULK_CHARGE_BATCHAcciónTool 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.
Parámetros de entrada
codestringObligatorioThe code for the charge whose batches you want to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch CustomerPAYSTACK_FETCH_CUSTOMERAcciónTool to get details of a customer on your integration. Use when you need to retrieve customer information using their customer code.
PAYSTACK_FETCH_CUSTOMERAcciónTool to get details of a customer on your integration. Use when you need to retrieve customer information using their customer code.
Parámetros de entrada
codestringObligatorioThe code for the customer gotten from the response of the customer creation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Mandate AuthorizationsPAYSTACK_FETCH_MANDATE_AUTHORIZATIONSAcciónTool to fetch the list of direct debit mandate authorizations associated with a customer. Use when you need to retrieve all mandate authorizations for a specific customer ID.
PAYSTACK_FETCH_MANDATE_AUTHORIZATIONSAcciónTool to fetch the list of direct debit mandate authorizations associated with a customer. Use when you need to retrieve all mandate authorizations for a specific customer ID.
Parámetros de entrada
idintegerObligatorioThe customer ID for the authorizations to fetch
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Payment PagePAYSTACK_FETCH_PAYMENT_PAGEAcciónTool 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.
PAYSTACK_FETCH_PAYMENT_PAGEAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of a payment page
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Payment Request DetailsPAYSTACK_FETCH_PAYMENT_REQUESTAcciónTool 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.
PAYSTACK_FETCH_PAYMENT_REQUESTAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of a previously created payment request
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Payment Session TimeoutPAYSTACK_FETCH_PAYMENT_SESSION_TIMEOUTAcciónTool to fetch the payment session timeout configured on your Paystack integration. Use when you need to check the current timeout duration for payment sessions.
PAYSTACK_FETCH_PAYMENT_SESSION_TIMEOUTAcciónTool to fetch the payment session timeout configured on your Paystack integration. Use when you need to check the current timeout duration for payment sessions.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch PlanPAYSTACK_FETCH_PLANAcciónTool to get details of a plan on your integration. Use when you need to retrieve plan information using the plan code or ID.
PAYSTACK_FETCH_PLANAcciónTool to get details of a plan on your integration. Use when you need to retrieve plan information using the plan code or ID.
Parámetros de entrada
codestringObligatorioThe plan ID or code you want to fetch
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch ProductPAYSTACK_FETCH_PRODUCTAcciónTool to get details of a product on your integration. Use when you need to retrieve product information by its ID.
PAYSTACK_FETCH_PRODUCTAcciónTool to get details of a product on your integration. Use when you need to retrieve product information by its ID.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the product
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Product OrdersPAYSTACK_FETCH_PRODUCT_ORDERSAcciónTool to fetch all orders for a particular product on your Paystack integration. Use when you need to retrieve order history and details for a specific product by its ID.
PAYSTACK_FETCH_PRODUCT_ORDERSAcciónTool to fetch all orders for a particular product on your Paystack integration. Use when you need to retrieve order history and details for a specific product by its ID.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the product
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch RefundPAYSTACK_FETCH_REFUNDAcciónTool 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.
PAYSTACK_FETCH_REFUNDAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe identifier of the refund to fetch.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch SplitPAYSTACK_FETCH_SPLITAcciónTool to get details of a split configuration for a transaction. Use when you need to retrieve split payment configuration information by its ID.
PAYSTACK_FETCH_SPLITAcciónTool to get details of a split configuration for a transaction. Use when you need to retrieve split payment configuration information by its ID.
Parámetros de entrada
idintegerObligatorioThe ID of the split configuration to fetch
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch StorefrontPAYSTACK_FETCH_STOREFRONTAcciónTool 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.
PAYSTACK_FETCH_STOREFRONTAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the Storefront to fetch
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Storefront OrdersPAYSTACK_FETCH_STOREFRONT_ORDERSAcciónTool to fetch all orders in a Paystack storefront. Use when you need to retrieve order information for a specific storefront using its ID.
PAYSTACK_FETCH_STOREFRONT_ORDERSAcciónTool to fetch all orders in a Paystack storefront. Use when you need to retrieve order information for a specific storefront using its ID.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the Storefront
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch SubaccountPAYSTACK_FETCH_SUBACCOUNTAcciónTool to get details of a subaccount on your integration. Use when you need to retrieve subaccount information using the subaccount code.
PAYSTACK_FETCH_SUBACCOUNTAcciónTool to get details of a subaccount on your integration. Use when you need to retrieve subaccount information using the subaccount code.
Parámetros de entrada
codestringObligatorioThe subaccount code you want to fetch
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch SubscriptionPAYSTACK_FETCH_SUBSCRIPTIONAcciónTool to get details of a subscription on your integration. Use when you need to retrieve subscription information using the subscription code.
PAYSTACK_FETCH_SUBSCRIPTIONAcciónTool to get details of a subscription on your integration. Use when you need to retrieve subscription information using the subscription code.
Parámetros de entrada
codestringObligatorioThe subscription code for the subscription you want to fetch
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch TransactionPAYSTACK_FETCH_TRANSACTIONAcciónTool 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.
PAYSTACK_FETCH_TRANSACTIONAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe ID of the transaction to fetch
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Transaction TimelinePAYSTACK_FETCH_TRANSACTION_TIMELINEAcciónTool 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.
PAYSTACK_FETCH_TRANSACTION_TIMELINEAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe ID of the transaction to fetch the timeline for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Transfer RecipientPAYSTACK_FETCH_TRANSFER_RECIPIENTAcciónTool to fetch details of a transfer recipient. Use when you need to retrieve information about an existing recipient using their recipient code.
PAYSTACK_FETCH_TRANSFER_RECIPIENTAcciónTool to fetch details of a transfer recipient. Use when you need to retrieve information about an existing recipient using their recipient code.
Parámetros de entrada
codestringObligatorioThe transfer recipient code obtained when the recipient was created. This unique code identifies the recipient in your integration.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Virtual TerminalPAYSTACK_FETCH_VIRTUAL_TERMINALAcciónTool 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.
PAYSTACK_FETCH_VIRTUAL_TERMINALAcciónTool 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.
Parámetros de entrada
codestringObligatorioCode of the Virtual Terminal
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Finalize Payment RequestPAYSTACK_FINALIZE_PAYMENT_REQUESTAcciónTool 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.
PAYSTACK_FINALIZE_PAYMENT_REQUESTAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of a draft payment request to finalize
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Generate Update Subscription LinkPAYSTACK_GENERATE_UPDATE_SUBSCRIPTION_LINKAcciónTool to generate a link for updating the card on a subscription. Use when you need to allow a customer to update their payment card for an active subscription.
PAYSTACK_GENERATE_UPDATE_SUBSCRIPTION_LINKAcciónTool to generate a link for updating the card on a subscription. Use when you need to allow a customer to update their payment card for an active subscription.
Parámetros de entrada
codestringObligatorioSubscription code for which to generate the update link
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Payment Request TotalsPAYSTACK_GET_PAYMENT_REQUEST_TOTALSAcciónTool 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.
PAYSTACK_GET_PAYMENT_REQUEST_TOTALSAcciónTool 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Transaction TotalsPAYSTACK_GET_TRANSACTION_TOTALSAcciónTool 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.
PAYSTACK_GET_TRANSACTION_TOTALSAcciónTool 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.
Parámetros de entrada
tostringThe 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.
fromstringThe 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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Initialize AuthorizationPAYSTACK_INITIALIZE_AUTHORIZATIONAcciónTool 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.
PAYSTACK_INITIALIZE_AUTHORIZATIONAcciónTool 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.
Parámetros de entrada
emailstringObligatorioCustomer's email address for the authorization
accountobjectCustomer's bank account details for direct debit authorization.
addressobjectCustomer's address information for authorization.
channelstringObligatorioenumAuthorization channel. Currently only direct_debit is supported for creating reusable authorizations
direct_debitcallback_urlstringFully qualified URL (e.g. https://example.com/) to redirect the customer to after authorization
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Initialize TransactionPAYSTACK_INITIALIZE_TRANSACTIONAcciónTool 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.
PAYSTACK_INITIALIZE_TRANSACTIONAcciónTool 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.
Parámetros de entrada
planstringIf transaction is to create a subscription to a predefined plan, provide plan code here. This would invalidate the value provided in amount
emailstringObligatorioCustomer's email address (required)
labelstringUsed to replace the email address shown on the Checkout form
splitobjectSplit configuration for transactions.
amountintegerObligatorioAmount should be in the smallest denomination of the currency (subunit). For example, 10000 kobo = 100 NGN, 10000 pesewas = 100 GHS
bearerstringenumWho bears the transaction charge.
accountsubaccountchannelsstring[]An array of payment channels to control what channels you want to make available to the user to make a payment with
currencystringenumSupported currencies for Paystack transactions.
GHSKESNGNZARUSDmetadataobjectJSON object of custom data to include with the transaction
referencestringUnique transaction reference. Only alphanumeric characters, hyphens, periods, and equals signs allowed. If not provided, Paystack will generate one
split_codestringThe split code of the transaction split. Use this to split payment between multiple accounts
subaccountstringThe code for the subaccount that owns the payment. This overrides the split configuration if provided
callback_urlstringFully 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
invoice_limitintegerNumber of times to charge customer during subscription to plan
transaction_chargeintegerA flat fee to charge the subaccount for this transaction in subunit. This overrides the split percentage set when the subaccount was created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Initiate Bulk ChargePAYSTACK_INITIATE_BULK_CHARGEAcciónTool to initiate a bulk charge on your integration. Use when you need to charge multiple customers at once using their authorization codes.
PAYSTACK_INITIATE_BULK_CHARGEAcciónTool to initiate a bulk charge on your integration. Use when you need to charge multiple customers at once using their authorization codes.
Parámetros de entrada
chargesobject[]ObligatorioArray of charge objects with authorization, amount, and optional reference. Each object represents a charge to be processed
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List BanksPAYSTACK_LIST_BANKSAcciónTool 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.
PAYSTACK_LIST_BANKSAcciónTool 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.
Parámetros de entrada
nextstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
pageintegerThe offset to retrieve data from (page number)
typestringenumTypes of financial channels.
ghippsmobile_moneynubankepssbasacountrystringenumSupported countries for bank listings.
ghanakenyanigeriasouth africagatewaystringenumGateway types for Nigerian banks.
emandatedigitalbankmandateperPageintegerThe number of records to fetch per request
currencystringenumSupported currencies for bank listings.
GHSKESNGNZARpreviousstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
use_cursorbooleanA flag to indicate if cursor based pagination should be used
pay_with_bankbooleanA flag to filter for banks a customer can pay directly from
include_nip_sort_codebooleanA flag that returns Nigerian banks with their NIP institution code. The returned value can be used in identifying institutions on NIP.
pay_with_bank_transferbooleanA flag to filter for available banks a customer can make a transfer to complete a payment
enabled_for_verificationbooleanA 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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Bulk Charge BatchesPAYSTACK_LIST_BULK_CHARGE_BATCHESAcciónTool 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.
PAYSTACK_LIST_BULK_CHARGE_BATCHESAcciónTool 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.
Parámetros de entrada
pageintegerThe page number to retrieve. Use this to navigate through paginated results.
statusstringenumStatus filter options for bulk charge batches.
activepausedcompleteperPageintegerNumber of records to fetch per page. Controls pagination size for the batch results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Charges in BatchPAYSTACK_LIST_CHARGES_IN_BATCHAcciónTool 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.
PAYSTACK_LIST_CHARGES_IN_BATCHAcciónTool 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.
Parámetros de entrada
codestringObligatorioThe batch code for the bulk charge whose charges you want to retrieve
pageintegerThe offset to retrieve data from (page number)
statusstringenumStatus values for filtering charges.
successfailedpendingerrorinactive_authorizationperPageintegerNumber of records to fetch per page
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List countriesPAYSTACK_LIST_COUNTRIESAcciónTool to retrieve a list of countries that Paystack currently supports. Use when you need to know which countries are available for Paystack operations.
PAYSTACK_LIST_COUNTRIESAcciónTool to retrieve a list of countries that Paystack currently supports. Use when you need to know which countries are available for Paystack operations.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CustomersPAYSTACK_LIST_CUSTOMERSAcciónTool to list customers available on your integration. Use when you need to retrieve all customers with optional filtering by date range and pagination support.
PAYSTACK_LIST_CUSTOMERSAcciónTool to list customers available on your integration. Use when you need to retrieve all customers with optional filtering by date range and pagination support.
Parámetros de entrada
nextstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
pagestringThe offset to retrieve data from (page number)
perPagestringThe number of records to fetch per request
to_datestringThe end date for filtering customers
previousstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
from_datestringThe start date for filtering customers
use_cursorbooleanA flag to indicate if cursor based pagination should be used
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List DisputesPAYSTACK_LIST_DISPUTESAcciónTool 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.
PAYSTACK_LIST_DISPUTESAcciónTool 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.
Parámetros de entrada
tostringThe end date for filtering disputes (ISO 8601 format or YYYY-MM-DD)
fromstringThe start date for filtering disputes (ISO 8601 format or YYYY-MM-DD)
pageintegerThe section to retrieve (page number)
statusstringenumStatus values for dispute filtering.
awaiting-merchant-feedbackawaiting-bank-feedbackpendingresolvedperPageintegerNumber of records to fetch per page
transactionstringTransaction ID to filter disputes
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Apple Pay DomainsPAYSTACK_LIST_DOMAINSAcciónTool to list all registered Apple Pay domains on your integration. Use when you need to retrieve domains configured for Apple Pay payments.
PAYSTACK_LIST_DOMAINSAcciónTool to list all registered Apple Pay domains on your integration. Use when you need to retrieve domains configured for Apple Pay payments.
Parámetros de entrada
nextstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
previousstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
use_cursorbooleanA flag to indicate if cursor based pagination should be used
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Mandate AuthorizationsPAYSTACK_LIST_MANDATE_AUTHORIZATIONSAcciónTool 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.
PAYSTACK_LIST_MANDATE_AUTHORIZATIONSAcciónTool 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.
Parámetros de entrada
cursorstringThe cursor value of the next set of authorizations to fetch. You can get this from the meta object of the response
statusstringenumStatus values for mandate authorizations.
pendingactiverevokedper_pageintegerThe number of authorizations to fetch per request
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List OrdersPAYSTACK_LIST_ORDERSAcciónTool to list orders available on your integration. Use when you need to retrieve all orders with optional filtering by date range and pagination support.
PAYSTACK_LIST_ORDERSAcciónTool to list orders available on your integration. Use when you need to retrieve all orders with optional filtering by date range and pagination support.
Parámetros de entrada
pageintegerThe section to retrieve
perPageintegerNumber of records to fetch per page
to_datestringThe end date for filtering orders
from_datestringThe start date for filtering orders
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Payment PagesPAYSTACK_LIST_PAYMENT_PAGESAcciónTool 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.
PAYSTACK_LIST_PAYMENT_PAGESAcciónTool 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.
Parámetros de entrada
tostringThe end date in ISO 8601 format (YYYY-MM-DD)
fromstringThe start date in ISO 8601 format (YYYY-MM-DD)
pageintegerThe section to retrieve
perPageintegerNumber of records to fetch per page
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Payment RequestsPAYSTACK_LIST_PAYMENT_REQUESTSAcciónTool 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.
PAYSTACK_LIST_PAYMENT_REQUESTSAcciónTool 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.
Parámetros de entrada
tostringThe end date for filtering payment requests (ISO 8601 format)
fromstringThe start date for filtering payment requests (ISO 8601 format)
pageintegerThe section to retrieve (page number)
statusstringenumStatus options for filtering payment requests.
draftpendingsuccessfailedperPageintegerNumber of records to fetch per page
currencystringIf your integration supports more than one currency, choose the one to filter by (e.g., NGN, GHS, ZAR, USD)
customerstringCustomer ID to filter payment requests for a specific customer
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PlansPAYSTACK_LIST_PLANSAcciónTool to list all subscription plans available on your integration. Use when you need to retrieve plans, optionally filtering by interval, amount, or date range.
PAYSTACK_LIST_PLANSAcciónTool to list all subscription plans available on your integration. Use when you need to retrieve plans, optionally filtering by interval, amount, or date range.
Parámetros de entrada
tostringFilter plans created up to this date (ISO 8601 format or YYYY-MM-DD).
fromstringFilter plans created from this date (ISO 8601 format or YYYY-MM-DD).
pageintegerThe page number to retrieve. Use this to navigate through paginated results.
amountintegerFilter plans by amount in subunit (kobo if NGN, pesewas if GHS, cents if ZAR or USD).
perPageintegerNumber of records to fetch per page. Controls pagination size for the plan results.
intervalstringenumPlan billing interval options.
dailyweeklymonthlybiannuallyannually
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ProductsPAYSTACK_LIST_PRODUCTSAcciónTool 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.
PAYSTACK_LIST_PRODUCTSAcciónTool 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.
Parámetros de entrada
pageintegerThe section to retrieve (page number)
activebooleanThe state of the product - filter by active status
perPageintegerNumber of records to fetch per page
to_datestringThe end date for filtering products
from_datestringThe start date for filtering products
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List RefundsPAYSTACK_LIST_REFUNDSAcciónTool 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.
PAYSTACK_LIST_REFUNDSAcciónTool 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.
Parámetros de entrada
tostringThe end date for filtering refunds (ISO 8601 format)
fromstringThe start date for filtering refunds (ISO 8601 format)
pageintegerThe section to retrieve (page number)
perPageintegerNumber of records to fetch per page
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SettlementsPAYSTACK_LIST_SETTLEMENTSAcciónTool to list settlements made to your settlement accounts. Use when you need to retrieve settlement information with optional pagination support.
PAYSTACK_LIST_SETTLEMENTSAcciónTool to list settlements made to your settlement accounts. Use when you need to retrieve settlement information with optional pagination support.
Parámetros de entrada
pageintegerThe offset to retrieve data from (page number for pagination).
perPageintegerThe number of records to fetch per request. Controls pagination size.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SplitsPAYSTACK_LIST_SPLITSAcciónTool to list the transaction splits available on your integration. Use when you need to retrieve all split configurations with optional filtering by name, status, subaccount, or date range.
PAYSTACK_LIST_SPLITSAcciónTool to list the transaction splits available on your integration. Use when you need to retrieve all split configurations with optional filtering by name, status, subaccount, or date range.
Parámetros de entrada
namestringThe name of the split to filter by
pageintegerThe offset to retrieve data from (page number)
activebooleanThe status of the split - true for active splits, false for inactive splits
to_datestringThe end date for filtering splits
per_pageintegerThe number of records to fetch per request
from_datestringThe start date for filtering splits
subaccount_codestringFilter by subaccount code
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List states for address verificationPAYSTACK_LIST_STATES_AVSAcciónTool 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.
PAYSTACK_LIST_STATES_AVSAcciónTool 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.
Parámetros de entrada
countrystringObligatorioThe country code of the states to list. It is gotten after the charge request.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Storefront ProductsPAYSTACK_LIST_STOREFRONT_PRODUCTSAcciónTool to list all products in a Paystack storefront. Use when you need to retrieve product information for a specific storefront using its ID.
PAYSTACK_LIST_STOREFRONT_PRODUCTSAcciónTool to list all products in a Paystack storefront. Use when you need to retrieve product information for a specific storefront using its ID.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the Storefront
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List StorefrontsPAYSTACK_LIST_STOREFRONTSAcciónTool to list storefronts available on your integration. Use when you need to retrieve all storefronts with optional filtering by status and pagination support.
PAYSTACK_LIST_STOREFRONTSAcciónTool to list storefronts available on your integration. Use when you need to retrieve all storefronts with optional filtering by status and pagination support.
Parámetros de entrada
pageintegerThe offset to retrieve data from. Use this to navigate through paginated results.
statusstringenumStorefront status options.
activeinactiveperPageintegerNumber of records to fetch per request. Controls pagination size for the storefront results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SubaccountsPAYSTACK_LIST_SUBACCOUNTSAcciónTool to list subaccounts available on your integration. Use when you need to retrieve all subaccounts with optional filtering by active status and pagination support.
PAYSTACK_LIST_SUBACCOUNTSAcciónTool to list subaccounts available on your integration. Use when you need to retrieve all subaccounts with optional filtering by active status and pagination support.
Parámetros de entrada
pageintegerThe offset to retrieve data from
activebooleanFilter by the state of the subaccounts
perPageintegerNumber of records to fetch per request
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SubscriptionsPAYSTACK_LIST_SUBSCRIPTIONSAcciónTool to list all subscriptions available on your integration. Use when you need to retrieve subscriptions, optionally filtering by plan, customer, or date range.
PAYSTACK_LIST_SUBSCRIPTIONSAcciónTool to list all subscriptions available on your integration. Use when you need to retrieve subscriptions, optionally filtering by plan, customer, or date range.
Parámetros de entrada
tostringFilter subscriptions created up to this date (ISO 8601 format or YYYY-MM-DD).
fromstringFilter subscriptions created from this date (ISO 8601 format or YYYY-MM-DD).
pageintegerThe page number to retrieve. Use this to navigate through paginated results.
planintegerFilter subscriptions by plan ID. Use this to retrieve subscriptions for a specific plan.
perPageintegerNumber of records to fetch per page. Controls pagination size for the subscription results.
customerstringFilter subscriptions by customer ID. Use this to retrieve subscriptions for a specific customer.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TransactionsPAYSTACK_LIST_TRANSACTIONSAcciónTool to list transactions that have occurred on your integration. Use when you need to retrieve all transactions with optional filtering by date range, status, source, channel, customer, and other criteria. Supports both cursor-based and page-based pagination.
PAYSTACK_LIST_TRANSACTIONSAcciónTool to list transactions that have occurred on your integration. Use when you need to retrieve all transactions with optional filtering by date range, status, source, channel, customer, and other criteria. Supports both cursor-based and page-based pagination.
Parámetros de entrada
nextstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
pageintegerThe offset to retrieve data from
amountintegerFilter transactions by a specific amount
sourcestringenumTransaction source values.
merchantApicheckoutposvirtualTerminalstatusstringenumTransaction status values.
successfailedabandonedreversedchannelstringenumPayment channel values.
cardposbankdedicated_nubanussdbank_transferto_datestringThe end date for filtering transactions
per_pageintegerThe number of records to fetch per request
previousstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
from_datestringThe start date for filtering transactions
settlementintegerThe settlement ID to filter for settled transactions
split_codestringFilter transaction by split code
use_cursorbooleanA flag to indicate if cursor based pagination should be used
terminal_idstringFilter transactions by a terminal ID
customer_codestringFilter transactions by a customer code
subaccount_codestringFilter transaction by subaccount code
virtual_account_numberstringFilter transactions by a virtual account number
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Transfer RecipientsPAYSTACK_LIST_TRANSFER_RECIPIENTSAcciónTool to list transfer recipients available on your integration. Use when you need to retrieve all recipients with optional pagination support.
PAYSTACK_LIST_TRANSFER_RECIPIENTSAcciónTool to list transfer recipients available on your integration. Use when you need to retrieve all recipients with optional pagination support.
Parámetros de entrada
nextstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
pageintegerThe offset to retrieve data from
per_pageintegerThe number of records to fetch per request
previousstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
use_cursorbooleanA flag to indicate if cursor based pagination should be used
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TransfersPAYSTACK_LIST_TRANSFERSAcciónTool 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.
PAYSTACK_LIST_TRANSFERSAcciónTool 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.
Parámetros de entrada
nextstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
pageintegerThe offset to retrieve data from (page number)
statusstringenumTransfer status filter options.
pendingsuccessfailedotpabandonedreversedblockedrejectedreceivedto_datestringThe end date for filtering transfers (YYYY-MM-DD format)
per_pageintegerThe number of records to fetch per request
previousstringAn alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
from_datestringThe start date for filtering transfers (YYYY-MM-DD format)
recipientstringFilter transfer by the recipient code
use_cursorbooleanA flag to indicate if cursor based pagination should be used
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Virtual TerminalsPAYSTACK_LIST_VIRTUAL_TERMINALSAcciónTool to list virtual terminals available on your integration. Use when you need to retrieve all virtual terminals with pagination support.
PAYSTACK_LIST_VIRTUAL_TERMINALSAcciónTool to list virtual terminals available on your integration. Use when you need to retrieve all virtual terminals with pagination support.
Parámetros de entrada
pageintegerThe offset to retrieve data from. Use this to navigate through paginated results.
perPageintegerThe number of records to fetch per request. Controls pagination size for the results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Pause Bulk ChargePAYSTACK_PAUSE_BULK_CHARGEAcciónTool to pause processing of a bulk charge batch. Use when you need to temporarily stop a bulk charge batch from processing further charges.
PAYSTACK_PAUSE_BULK_CHARGEAcciónTool to pause processing of a bulk charge batch. Use when you need to temporarily stop a bulk charge batch from processing further charges.
Parámetros de entrada
codestringObligatorioThe batch code for the bulk charge you want to pause
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Publish StorefrontPAYSTACK_PUBLISH_STOREFRONTAcciónTool 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.
PAYSTACK_PUBLISH_STOREFRONTAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the Storefront to publish. You can obtain storefront IDs from PAYSTACK_CREATE_STOREFRONT or by listing storefronts.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove Subaccount from SplitPAYSTACK_REMOVE_SUBACCOUNT_FROM_SPLITAcciónTool 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.
PAYSTACK_REMOVE_SUBACCOUNT_FROM_SPLITAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe ID of the split configuration to update
shareintegerObligatorioThe share amount currently allocated to this subaccount in the split. This value must match the subaccount's current share allocation.
subaccountstringObligatorioSubaccount code of the customer or partner to remove from the split. This code starts with 'ACCT_'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Resend OTP for TransferPAYSTACK_RESEND_OTP_FOR_TRANSFERAcciónTool 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.
PAYSTACK_RESEND_OTP_FOR_TRANSFERAcciónTool 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.
Parámetros de entrada
reasonstringObligatorioenumSpecify the flag to indicate the purpose of the OTP. Valid values are 'disable_otp' or 'transfer'
disable_otptransfertransfer_codestringObligatorioThe transfer code that requires an OTP validation
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Resolve Card BINPAYSTACK_RESOLVE_CARD_BINAcciónTool 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.
PAYSTACK_RESOLVE_CARD_BINAcciónTool 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.
Parámetros de entrada
binintegerObligatorioThe card bank identification number (first 6 digits of the card)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Resume Bulk Charge BatchPAYSTACK_RESUME_BULK_CHARGE_BATCHAcciónTool 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.
PAYSTACK_RESUME_BULK_CHARGE_BATCHAcciónTool 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.
Parámetros de entrada
codestringObligatorioThe batch code for the bulk charge you want to resume
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send Payment Request NotificationPAYSTACK_SEND_PAYMENT_REQUEST_NOTIFICATIONAcciónTool 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.
PAYSTACK_SEND_PAYMENT_REQUEST_NOTIFICATIONAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of a previously created payment request. This action will trigger an email reminder to the customer.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send Subscription Update LinkPAYSTACK_SEND_SUBSCRIPTION_UPDATE_LINKAcciónTool to send an email to the customer with a link to update the card on their subscription. Use when a customer needs to update their payment card for an active subscription and you want to notify them via email.
PAYSTACK_SEND_SUBSCRIPTION_UPDATE_LINKAcciónTool to send an email to the customer with a link to update the card on their subscription. Use when a customer needs to update their payment card for an active subscription and you want to notify them via email.
Parámetros de entrada
codestringObligatorioSubscription code for which to send the update link email. This code identifies the subscription whose payment card details need updating.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Risk ActionPAYSTACK_SET_RISK_ACTIONAcciónTool 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).
PAYSTACK_SET_RISK_ACTIONAcciónTool 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).
Parámetros de entrada
customerstringObligatorioCustomer code or email address to set risk action for
risk_actionstringenumRisk action types that can be applied to a customer.
allowdenydefault
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Submit PhonePAYSTACK_SUBMIT_PHONEAcciónTool to submit phone number when requested during a charge transaction. Use this when a charge requires phone number submission for verification or authentication purposes.
PAYSTACK_SUBMIT_PHONEAcciónTool to submit phone number when requested during a charge transaction. Use this when a charge requires phone number submission for verification or authentication purposes.
Parámetros de entrada
phonestringObligatorioCustomer's mobile phone number
referencestringObligatorioThe reference of the ongoing transaction
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Trigger direct debit activation chargePAYSTACK_TRIGGER_DIRECT_DEBIT_ACTIVATION_CHARGEAcciónTool to trigger an activation charge on an inactive direct debit mandate for a customer. Use when a mandate needs to be reactivated or retried.
PAYSTACK_TRIGGER_DIRECT_DEBIT_ACTIVATION_CHARGEAcciónTool to trigger an activation charge on an inactive direct debit mandate for a customer. Use when a mandate needs to be reactivated or retried.
Parámetros de entrada
idintegerObligatorioThe customer ID attached to the authorization. This identifies the customer whose direct debit mandate needs activation.
authorization_idintegerObligatorioThe authorization ID obtained from the direct debit initiation response. This identifies the specific mandate to activate.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unassign Destination from Virtual TerminalPAYSTACK_UNASSIGN_DESTINATION_FROM_VIRTUAL_TERMINALAcciónTool 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.
PAYSTACK_UNASSIGN_DESTINATION_FROM_VIRTUAL_TERMINALAcciónTool 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.
Parámetros de entrada
codestringObligatorioCode of the Virtual Terminal to unassign destinations from
targetsstring[]ObligatorioArray of WhatsApp numbers in international format (E.164) to unassign from the Virtual Terminal, e.g., +2548012345678
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unregister Apple Pay DomainPAYSTACK_UNREGISTER_APPLE_PAY_DOMAINAcciónTool 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.
PAYSTACK_UNREGISTER_APPLE_PAY_DOMAINAcciónTool 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.
Parámetros de entrada
domainNamestringObligatorioThe domain name or subdomain to unregister from Apple Pay integration. Must be a previously registered domain.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CustomerPAYSTACK_UPDATE_CUSTOMERAcciónTool 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.
PAYSTACK_UPDATE_CUSTOMERAcciónTool 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.
Parámetros de entrada
codestringObligatorioThe code for the customer gotten from the response of the customer creation
phonestringCustomer's phone number
metadatastringStringified JSON object of custom data
last_namestringCustomer's last name
first_namestringCustomer's first name
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Payment PagePAYSTACK_UPDATE_PAYMENT_PAGEAcciónTool 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.
PAYSTACK_UPDATE_PAYMENT_PAGEAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the payment page to update
namestringName of the payment page
activebooleanSet to false to deactivate page url
amountintegerAmount should be in the subunit of the currency (kobo if currency is NGN, pesewas if currency is GHS, and cents if currency is ZAR)
descriptionstringThe description of the page
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Payment RequestPAYSTACK_UPDATE_PAYMENT_REQUESTAcciónTool 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.
PAYSTACK_UPDATE_PAYMENT_REQUESTAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of a previously created payment request
taxobject[]Array of taxes to apply to the payment request
draftbooleanIndicate if request should be saved as draft. Defaults to false and overrides send_notification
amountintegerPayment 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.
currencystringenumCurrency options for payment requests.
NGNGHSZARUSDcustomerstringCustomer id or code
due_datestringISO 8601 representation of request due date
line_itemsobject[]Array of line items for the payment request
split_codestringThe split code of the transaction split. This allows you to split the payment with one or more accounts
descriptionstringA short description of the payment request
has_invoicebooleanSet 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
invoice_numberintegerNumeric 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.
send_notificationbooleanIndicates whether Paystack sends an email notification to customer. Defaults to true
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Payment Session TimeoutPAYSTACK_UPDATE_PAYMENT_SESSION_TIMEOUTAcciónTool to update the payment session timeout on your Paystack integration. Use when you need to change the duration before a payment session expires.
PAYSTACK_UPDATE_PAYMENT_SESSION_TIMEOUTAcciónTool to update the payment session timeout on your Paystack integration. Use when you need to change the duration before a payment session expires.
Parámetros de entrada
timeoutintegerObligatorioTimeout before canceling session in seconds. Valid range is 60-3600 seconds (1 minute to 1 hour). Set to 0 to disable session timeouts entirely.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update PlanPAYSTACK_UPDATE_PLANAcciónTool 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.
PAYSTACK_UPDATE_PLANAcciónTool 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.
Parámetros de entrada
codestringObligatorioThe plan code you want to update
namestringName of the plan
amountintegerAmount to charge in subunit (kobo if currency is NGN, pesewas if currency is GHS, cents if currency is ZAR or USD)
currencystringenumSupported currencies for plans
NGNGHSZARUSDintervalstringenumInterval for recurring payments
dailyweeklymonthlybiannuallyannuallysend_smsbooleanSet to false if you don't want text messages to be sent to your customers
descriptionstringA description for this plan
invoice_limitintegerNumber of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing
send_invoicesbooleanSet to false if you don't want invoices to be sent to your customers
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ProductPAYSTACK_UPDATE_PRODUCTAcciónTool to update a product on your integration. Use when you need to modify product details like name, description, price, or currency.
PAYSTACK_UPDATE_PRODUCTAcciónTool to update a product on your integration. Use when you need to modify product details like name, description, price, or currency.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the product to update
namestringName of product
priceintegerPrice should be in kobo if currency is NGN, pesewas if currency is GHS, and cents if currency is ZAR
currencystringenumSupported currency codes for Paystack products.
NGNGHSZARUSDmetadataobjectJSON object of custom data
quantityintegerNumber of products in stock. Use if unlimited is false
unlimitedbooleanSet to true if the product has unlimited stock. Leave as false if the product has limited stock
split_codestringThe split code if sharing the transaction with partners
descriptionstringThe description of the product
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Split ConfigurationPAYSTACK_UPDATE_SPLITAcciónTool to update a split configuration for transactions. Use when you need to modify split settings such as name, active status, or bearer type.
PAYSTACK_UPDATE_SPLITAcciónTool to update a split configuration for transactions. Use when you need to modify split settings such as name, active status, or bearer type.
Parámetros de entrada
idstringObligatorioThe ID or code of the split configuration to update
namestringName of the transaction split
activebooleanToggle status of split. When true, the split is active, else it's inactive
bearer_typestringenumWho bears the Paystack transaction charges.
subaccountaccountall-proportionalallbearer_subaccountstringSubaccount 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
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update StorefrontPAYSTACK_UPDATE_STOREFRONTAcciónTool to update the details of a previously created Storefront. Use when you need to modify storefront information such as name, description, or slug.
PAYSTACK_UPDATE_STOREFRONTAcciónTool to update the details of a previously created Storefront. Use when you need to modify storefront information such as name, description, or slug.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the Storefront to update
namestringName of the storefront
slugstringA unique identifier to access your store. Once the storefront is created, it can be accessed from https://paystack.shop/your-slug
descriptionstringThe description of the storefront
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SubaccountPAYSTACK_UPDATE_SUBACCOUNTAcciónTool 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.
PAYSTACK_UPDATE_SUBACCOUNTAcciónTool 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.
Parámetros de entrada
codestringObligatorioThe subaccount code you want to update
activebooleanActivate or deactivate a subaccount
metadatastringStringified JSON object of custom data
descriptionstringA description for this subaccount
business_namestringName of business for subaccount
account_numberstringBank account number
settlement_bankstringBank code for the bank. You can get the list of Bank Codes by calling the List Banks endpoint.
percentage_chargenumberPercentage of transaction amount charged by the subaccount
primary_contact_namestringThe name of the contact person for this subaccount
primary_contact_emailstringA contact email for the subaccount
primary_contact_phonestringA phone number to call for this subaccount
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Transfer RecipientPAYSTACK_UPDATE_TRANSFER_RECIPIENTAcciónTool to update the details of a transfer recipient. Use when you need to modify an existing recipient's name or email address.
PAYSTACK_UPDATE_TRANSFER_RECIPIENTAcciónTool to update the details of a transfer recipient. Use when you need to modify an existing recipient's name or email address.
Parámetros de entrada
codestringObligatorioThe transfer recipient code obtained when the recipient was created. This unique code identifies the recipient to be updated.
namestringThe recipient's name according to their account registration. This is the name that will appear on transfer receipts.
emailstringEmail address of the recipient. Optional but recommended for better record-keeping and communication.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Validate Bank AccountPAYSTACK_VALIDATE_BANK_ACCOUNTAcciónTool 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.
PAYSTACK_VALIDATE_BANK_ACCOUNTAcciónTool 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.
Parámetros de entrada
bank_codestringObligatorioThe bank code of the customer's bank (required). You can fetch the bank codes by using the List Banks endpoint.
account_namestringObligatorioCustomer's first and last name registered with their bank (required)
account_typestringObligatorioenumThe type of the customer's account number (required)
personalbusinesscountry_codestringObligatorioThe two digit ISO code of the customer's bank (required)
document_typestringObligatorioenumCustomer's mode of identity (required)
identityNumberpassportNumberbusinessRegistrationNumberaccount_numberstringObligatorioCustomer's account number (required)
document_numberstringCustomer's mode of identity number
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Validate CustomerPAYSTACK_VALIDATE_CUSTOMERAcciónTool 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.
PAYSTACK_VALIDATE_CUSTOMERAcciónTool 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.
Parámetros de entrada
bvnstringObligatorioCustomer's Bank Verification Number
codestringObligatorioThe code for the customer gotten from the response of the customer creation
typestringObligatorioPredefined types of identification. Typically 'bank_account'
valuestringCustomer's identification number
countrystringObligatorioTwo-letter country code of identification issuer
bank_codestringObligatorioBank code. You can get the list of bank codes by calling the List Banks endpoint (https://api.paystack.co/bank)
last_namestringObligatorioCustomer's last name
first_namestringObligatorioCustomer's first name
middle_namestringCustomer's middle name
account_numberstringObligatorioCustomer's bank account number
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Validate OrderPAYSTACK_VALIDATE_ORDERAcciónTool 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.
PAYSTACK_VALIDATE_ORDERAcciónTool 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.
Parámetros de entrada
codestringObligatorioThe unique code of a previously created order
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Verify Payment RequestPAYSTACK_VERIFY_PAYMENT_REQUESTAcciónTool 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.
PAYSTACK_VERIFY_PAYMENT_REQUESTAcciónTool 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.
Parámetros de entrada
idstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Verify Storefront SlugPAYSTACK_VERIFY_STOREFRONT_SLUGAcciónTool to verify the availability of a slug before using it for a Storefront. Use when you need to check if a slug is available before creating a new storefront.
PAYSTACK_VERIFY_STOREFRONT_SLUGAcciónTool to verify the availability of a slug before using it for a Storefront. Use when you need to check if a slug is available before creating a new storefront.
Parámetros de entrada
slugstringObligatorioThe custom slug to verify for storefront availability. Used when creating a storefront.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Verify TransactionPAYSTACK_VERIFY_TRANSACTIONAcciónTool 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.
PAYSTACK_VERIFY_TRANSACTIONAcciónTool 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.
Parámetros de entrada
referencestringObligatorioThe transaction reference to verify
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not