Paystack - Apps Documentation

Requirements

Connecting Paystack takes an active account plus an API access token from your account settings — no other setup is required.[3]

Get your Paystack credentials

Secret KeypasswordRequired
Your secret API key (Settings → API Keys & Webhooks in the dashboard). Use a test secret key while building, and swap in a live secret key when you go live.
[1]

Connect Paystack in WEXTL

Log in to your WEXTL account, add the Paystack node module to your workflow, and click Create new credential.
Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Paystack account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Paystack node modules

The list below is a reference of every Paystack node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Expand any Paystack node module below to see exactly what it takes in, what it returns, and what connection it needs.

Watch New CustomersTrigger

Output fields[3]

Field	Type
ID	number
First Name	text
Last Name	text
Email	email
Customer Code	text
Phone	text
Metadata	text
Risk Action	text
Domain	text

3other output fields

Watch New DisputesTrigger

Output fields[3]

Field	Type
ID	number
Refund Amount	number
Currency	text
Status	text
Resolution	text
Transaction	object
ID	number
Reference	text
Amount	number
Currency	text
Category	text
Customer	object
ID	number
Email	email
Customer Code	text
Due At	date

3other output fields

Watch New PlansTrigger

Output fields[3]

Field	Type
ID	number
Name	text
Plan Code	text
Description	text
Amount	number
Interval	text
Invoice Limit	number
Send Invoices	boolean
Send SMS	boolean

5other output fields

Watch New RefundsTrigger

Output fields[3]

Field	Type
ID	number
Transaction	object
ID	number
Reference	text
Amount	number
Currency	text
Amount	number
Deducted Amount	number
Currency	text
Channel	text
Fully Deducted	boolean
Refunded By	text
Refunded At	date

6other output fields

Watch New TransactionsTrigger

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Reference	text
Amount	number
Message	text
Gateway Response	text
Paid At	date
Created At	date

5other output fields

Watch New TransfersTrigger

Output fields[3]

Field	Type
ID	number
Domain	text
Amount	number
Currency	text
Source	text
Reason	text
Recipient	object
ID	number
Type	text
Name	text
Recipient Code	text
Status	text
Transfer Code	text

3other output fields

Watch Webhook EventTrigger

Output fields[3]

Field	Type
Event	text
Data	object
ID	number
Domain	text
Status	text
Reference	text
Amount	number
Message	text
Gateway Response	text
Paid At	date
Created At	date
Channel	text

Balance LedgerSearch

Input fields[3]

Field	Type
From	date
To	date
Limit	number

Output fields[3]

Field	Type
Integration	number
Domain	text
Balance	number
Currency	text
Difference	number
Reason	text
Model Responsible	text
Model Row	number
Created At	date

1other output field

Check Pending ChargeSearch

Input fields[3]

Field	Type
ReferenceRequired	text

Output fields[3]

Field	Type
Reference	text
Status	text
Display Text	text
ID	number
Amount	number
Currency	text
Transaction Date	date
Domain	text
Gateway Response	text

6other output fields

Check Slug AvailabilitySearch

Input fields[3]

Field	Type
SlugRequired	text

Output fields[3]

Field	Type
Status	boolean
Message	text

Export DisputesSearch

Input fields[3]

Field	Type
Per Page	number
Page	number
From	date
To	date
Status	choice

Output fields[3]

Field	Type
Download URL	url

Export TransactionsSearch

Input fields[3]

Field	Type
Per Page	number
Page	number
From	date
To	date
Settled	boolean
Payment Page	text
Customer	text
Currency	choice
Amount	number

2other input fields

Output fields[3]

Field	Type
Path	text
Expires At	date

Export TransfersSearch

Input fields[3]

Field	Type
Per Page	number
Page	number
Status	choice
From	date
To	date

Output fields[3]

Field	Type
Path	text
Expires At	date

Fetch BalanceSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Currency	text
Balance	number

Fetch Bank ProvidersSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Provider Slug	text
Bank ID	text
Bank Name	text

Fetch BanksSearch

Input fields[3]

Field	Type
Country	text
Use Cursor	boolean
Next Cursor	text
Previous Cursor	text
Pay With Bank Transfer	boolean
Pay With Bank	boolean
Enabled For Verification	boolean
Gateway	text
Type	text

2other input fields

Output fields[3]

Field	Type
ID	number
Name	text
Slug	text
Code	text
Longcode	text
Gateway	text
Pay With Bank	boolean
Active	boolean
Country	text

4other output fields

Fetch Bulk Charge BatchSearch

Input fields[3]

Field	Type
Batch CodeRequired	text

Output fields[3]

Field	Type
ID	number
Batch Code	text
Reference	text
Status	text
Total Charges	number
Pending Charges	number
Created At	date
Updated At	date

Fetch Charges in a BatchSearch

Input fields[3]

Field	Type
Batch CodeRequired	text
Status	text
Limit	number

Output fields[3]

Field	Type
Integration	number
Bulk Charge	number
Customer	object
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text
Authorization	object
Authorization Code	text
Bin	text
Last 4	text
Channel	text
Card Type	text
Bank	text
Transaction	object
ID	number
Reference	text
Status	text
Amount	number
Currency	text
Domain	text
Amount	number
Currency	text
Status	text

2other output fields

Fetch CustomerSearch

Input fields[3]

Field	Type
CodeRequired	text

Output fields[3]

Field	Type
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text
Phone	text
Metadata	text
Risk Action	text
International Format Phone	text

6other output fields

Fetch Dedicated AccountSearch

Input fields[3]

Field	Type
Account IDRequired	number

Output fields[3]

Field	Type
ID	number
Account Number	text
Account Name	text
Currency	text
Bank	object
Name	text
ID	number
Slug	text
Assigned	boolean
Customer	object
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text
Split Config	object
Subaccount	text
Active	boolean

3other output fields

Fetch DisputeSearch

Input fields[3]

Field	Type
IDRequired	text

Output fields[3]

Field	Type
ID	number
Refund Amount	number
Currency	text
Status	text
Resolution	text
Transaction	object
ID	number
Reference	text
Amount	number
Currency	text
Transaction Reference	text
Category	text
Customer	object
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text

9other output fields

Fetch PageSearch

Input fields[3]

Field	Type
IDRequired	number

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Amount	number
Currency	text
Slug	text
Redirect URL	text
Success Message	text
Collect Phone	boolean

10other output fields

Fetch Payment RequestSearch

Input fields[3]

Field	Type
IDRequired	number

Output fields[3]

Field	Type
ID	number
Domain	text
Invoice Number	number
Amount	number
Discount	number
Currency	text
Due Date	date
Has Invoice	boolean
Description	text

11other output fields

Fetch Payment Session TimeoutSearch

Output fields[3]

Field	Type
Payment Session Timeout	number

Fetch PlanSearch

Input fields[3]

Field	Type
CodeRequired	text

Output fields[3]

Field	Type
ID	number
Name	text
Plan Code	text
Description	text
Amount	number
Interval	text
Invoice Limit	number
Send Invoices	boolean
Send SMS	boolean

7other output fields

Fetch ProductSearch

Input fields[3]

Field	Type
IDRequired	number

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Product Code	text
Price	number
Currency	text
Quantity	number
Quantity Sold	number
Type	text

8other output fields

Fetch RefundSearch

Input fields[3]

Field	Type
IDRequired	text

Output fields[3]

Field	Type
ID	number
Transaction	object
ID	number
Reference	text
Amount	number
Currency	text
Dispute	text
Settlement	text
Amount	number
Deducted Amount	number
Currency	text
Channel	text
Fully Deducted	boolean

8other output fields

Fetch SettlementsSearch

Input fields[3]

Field	Type
From	date
To	date
Subaccount	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Currency	text
Total Amount	number
Effective Amount	number
Total Fees	number
Total Processed	number
Deductions	text

4other output fields

Fetch SplitSearch

Input fields[3]

Field	Type
IDRequired	text

Output fields[3]

Field	Type
ID	number
Name	text
Type	text
Currency	text
Domain	text
Split Code	text
Active	boolean
Bearer Type	text
Bearer Subaccount	text

5other output fields

Fetch SubaccountSearch

Input fields[3]

Field	Type
CodeRequired	choice

Output fields[3]

Field	Type
ID	number
Subaccount Code	text
Business Name	text
Description	text
Primary Contact Name	text
Primary Contact Email	text
Primary Contact Phone	text
Metadata	text
Percentage Charge	number

11other output fields

Fetch SubscriptionSearch

Input fields[3]

Field	Type
CodeRequired	text

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Subscription Code	text
Email Token	text
Amount	number
Cron Expression	text
Next Payment Date	date
Open Invoice	text

11other output fields

Fetch TransactionSearch

Input fields[3]

Field	Type
IDRequired	text

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Reference	text
Amount	number
Message	text
Gateway Response	text
Paid At	date
Created At	date

10other output fields

Fetch Transaction TimelineSearch

Input fields[3]

Field	Type
Transaction ID or ReferenceRequired	text

Output fields[3]

Field	Type
History	array

Fetch TransferSearch

Input fields[3]

Field	Type
CodeRequired	text

Output fields[3]

Field	Type
ID	number
Domain	text
Amount	number
Currency	text
Source	text
Source Details	text
Reason	text
Recipient	object
ID	number
Type	text
Name	text
Recipient Code	text
Details	object
Status	text

5other output fields

Fetch Transfer RecipientSearch

Input fields[3]

Field	Type
CodeRequired	choice

Output fields[3]

Field	Type
ID	number
Active	boolean
Currency	text
Description	text
Domain	text
Metadata	text
Name	text
Recipient Code	text
Type	text

4other output fields

Get Dispute Upload URLSearch

Input fields[3]

Field	Type
IDRequired	text
Upload FilenameRequired	text

Output fields[3]

Field	Type
Signed URL	url
File Name	text

Get Transaction EventSearch

Input fields[3]

Field	Type
IDRequired	text

Output fields[3]

Field	Type
Message	text

Get Transaction SessionSearch

Input fields[3]

Field	Type
IDRequired	text

Output fields[3]

Field	Type
Message	text

List Bulk Charge BatchesSearch

Input fields[3]

Field	Type
From	date
To	date
Limit	number

Output fields[3]

Field	Type
ID	number
Batch Code	text
Reference	text
Status	text
Total Charges	number
Pending Charges	number
Created At	date
Updated At	date

List CountriesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
ISO Code	text
Default Currency Code	text

List CustomersSearch

Input fields[3]

Field	Type
Use Cursor	boolean
Next Cursor	text
Previous Cursor	text
From	date
To	date
Limit	number

Output fields[3]

Field	Type
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text
Phone	text
Metadata	text
Risk Action	text
International Format Phone	text

6other output fields

List Dedicated AccountsSearch

Input fields[3]

Field	Type
Account Number	text
Active	boolean
Currency	text
Provider Slug	text
Bank ID	text
Customer	text
Limit	number

Output fields[3]

Field	Type
ID	number
Account Number	text
Account Name	text
Currency	text
Bank	object
Name	text
ID	number
Slug	text
Assigned	boolean
Customer	object
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text
Split Config	object
Subaccount	text
Active	boolean

3other output fields

List DisputesSearch

Input fields[3]

Field	Type
From	date
To	date
Status	choice
Transaction	text
Limit	number

Output fields[3]

Field	Type
ID	number
Refund Amount	number
Currency	text
Status	text
Resolution	text
Transaction	object
ID	number
Reference	text
Amount	number
Currency	text
Transaction Reference	text
Category	text
Customer	object
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text

9other output fields

List PagesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Amount	number
Currency	text
Slug	text
Redirect URL	text
Success Message	text
Collect Phone	boolean

10other output fields

List Payment RequestsSearch

Input fields[3]

Field	Type
Customer	text
Status	choice
Currency	text
Include Archive	boolean
Limit	number

Output fields[3]

Field	Type
ID	number
Domain	text
Invoice Number	number
Amount	number
Discount	number
Currency	text
Due Date	date
Has Invoice	boolean
Description	text

11other output fields

List PlansSearch

Input fields[3]

Field	Type
Interval	choice
Amount	number
From	date
To	date
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Plan Code	text
Description	text
Amount	number
Interval	text
Invoice Limit	number
Send Invoices	boolean
Send SMS	boolean

7other output fields

List ProductsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Product Code	text
Price	number
Currency	text
Quantity	number
Quantity Sold	number
Type	text

8other output fields

List RefundsSearch

Input fields[3]

Field	Type
From	date
To	date
Limit	number

Output fields[3]

Field	Type
ID	number
Transaction	object
ID	number
Reference	text
Amount	number
Currency	text
Dispute	text
Settlement	text
Amount	number
Deducted Amount	number
Currency	text
Channel	text
Fully Deducted	boolean

8other output fields

List SplitsSearch

Input fields[3]

Field	Type
Name	text
Active	boolean
Sort By	text
From	date
To	date
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Type	text
Currency	text
Domain	text
Split Code	text
Active	boolean
Bearer Type	text
Bearer Subaccount	text

5other output fields

List States (AVS)Search

Input fields[3]

Field	Type
Country	text
Type	text
Currency	choice
Limit	number

Output fields[3]

Field	Type
Name	text
Slug	text
Abbreviation	text

List SubaccountsSearch

Input fields[3]

Field	Type
From	date
To	date
Limit	number

Output fields[3]

Field	Type
ID	number
Subaccount Code	text
Business Name	text
Description	text
Primary Contact Name	text
Primary Contact Email	text
Primary Contact Phone	text
Metadata	text
Percentage Charge	number

11other output fields

List SubscriptionsSearch

Input fields[3]

Field	Type
Customer	text
Plan	text
Limit	number

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Subscription Code	text
Email Token	text
Amount	number
Cron Expression	text
Next Payment Date	date
Open Invoice	text

11other output fields

List Transaction DisputesSearch

Input fields[3]

Field	Type
IDRequired	text
Limit	number

Output fields[3]

Field	Type
ID	number
Refund Amount	number
Currency	text
Status	text
Resolution	text
Transaction	object
ID	number
Reference	text
Amount	number
Currency	text
Transaction Reference	text
Category	text
Customer	object
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text

9other output fields

List TransactionsSearch

Input fields[3]

Field	Type
From	date
To	date
Customer	text
Status	choice
Amount	number
Limit	number

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Reference	text
Amount	number
Message	text
Gateway Response	text
Paid At	date
Created At	date

10other output fields

List Transfer RecipientsSearch

Input fields[3]

Field	Type
From	date
To	date
Limit	number

Output fields[3]

Field	Type
ID	number
Active	boolean
Currency	text
Description	text
Domain	text
Metadata	text
Name	text
Recipient Code	text
Type	text

4other output fields

List TransfersSearch

Input fields[3]

Field	Type
From	date
To	date
Status	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Domain	text
Amount	number
Currency	text
Source	text
Source Details	text
Reason	text
Recipient	object
ID	number
Type	text
Name	text
Recipient Code	text
Details	object
Status	text

5other output fields

Payment Request TotalsSearch

Output fields[3]

Field	Type
Pending	array
Successful	array
Total	array

Resolve Account NumberSearch

Input fields[3]

Field	Type
Account NumberRequired	text
Bank CodeRequired	choice

Output fields[3]

Field	Type
Account Number	text
Account Name	text
Bank ID	number

Resolve BVNSearch

Input fields[3]

Field	Type
BVNRequired	text

Output fields[3]

Field	Type
BVN	text
First Name	text
Last Name	text
Date of Birth	text

Resolve Card BINSearch

Input fields[3]

Field	Type
BINRequired	text

Output fields[3]

Field	Type
BIN	text
Brand	text
Sub Brand	text
Country Code	text
Country Name	text
Card Type	text
Bank	text
Linked Bank ID	number

Settlement TransactionsSearch

Input fields[3]

Field	Type
IDRequired	text
From	date
To	date
Limit	number

Output fields[3]

Field	Type
ID	number
Reference	text
Amount	number
Currency	text
Status	text
Paid At	date
Channel	text

Transaction TotalsSearch

Input fields[3]

Field	Type
From	date
To	date

Output fields[3]

Field	Type
Total Transactions	number
Total Volume	number
Total Volume By Currency	array
Pending Transfers	number
Pending Transfers By Currency	array

Verify Payment RequestSearch

Input fields[3]

Field	Type
IDRequired	number

Output fields[3]

Field	Type
ID	number
Request Code	text
Status	text
Paid	boolean
Paid At	date
Amount	number
Currency	text
Due Date	date

Verify TransactionSearch

Input fields[3]

Field	Type
ReferenceRequired	text

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Reference	text
Amount	number
Message	text
Gateway Response	text
Paid At	date
Created At	date

10other output fields

Verify TransferSearch

Input fields[3]

Field	Type
ReferenceRequired	text

Output fields[3]

Field	Type
ID	number
Domain	text
Amount	number
Currency	text
Source	text
Source Details	text
Reason	text
Recipient	object
ID	number
Type	text
Name	text
Recipient Code	text
Details	object
Status	text

5other output fields

Add Dispute EvidenceAction

Input fields[3]

Field	Type
IDRequired	text
Customer EmailRequired	text
Customer NameRequired	text
Customer PhoneRequired	text
Service DetailsRequired	text
Delivery Address	text
Delivery Date	date

Output fields[3]

Field	Type
Customer Email	text
Customer Name	text
Customer Phone	text
Service Details	text
Delivery Address	text
Delivery Date	date
Dispute ID	number
Created At	date
Updated At	date

1other output field

Add Products to PageAction

Input fields[3]

Field	Type
IDRequired	number
ProductsRequired	choice

Output fields[3]

Field	Type
Message	text

Add Subaccount to SplitAction

Input fields[3]

Field	Type
IDRequired	text
SubaccountRequired	choice
ShareRequired	number

Output fields[3]

Field	Type
ID	number
Name	text
Type	text
Currency	text
Domain	text
Split Code	text
Active	boolean
Bearer Type	text
Bearer Subaccount	text

5other output fields

Archive Payment RequestAction

Input fields[3]

Field	Type
IDRequired	number

Output fields[3]

Field	Type
Message	text

Bulk Create Transfer RecipientAction

Input fields[3]

Field	Type
BatchRequired	array

Output fields[3]

Field	Type
Success	array
Errors	array

BVN MatchAction

Input fields[3]

Field	Type
BVNRequired	text
Account NumberRequired	text
Bank CodeRequired	choice
First Name	text
Middle Name	text
Last Name	text

Output fields[3]

Field	Type
BVN	text
First Name	text
Last Name	text
Middle Name	text

Charge AuthorizationAction

Input fields[3]

Field	Type
EmailRequired	text
AmountRequired	number
Authorization CodeRequired	text
Reference	text
Currency	choice
Metadata	text
Split Code	choice
Subaccount	choice
Transaction Charge	number

2other input fields

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Reference	text
Amount	number
Message	text
Gateway Response	text
Paid At	date
Created At	date

10other output fields

Check AuthorizationAction

Input fields[3]

Field	Type
EmailRequired	text
AmountRequired	number
Authorization CodeRequired	text

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Reference	text
Amount	number
Message	text
Gateway Response	text
Paid At	date
Created At	date

10other output fields

Create ChargeAction

Input fields[3]

Field	Type
EmailRequired	email
AmountRequired	number
Bank	object
Bank Code	text
Account Number	text
Authorization Code	text
USSD	object
USSD Type	choice
Mobile Money	object
Phone	text
Provider	text
EFT	object
Provider	choice
PIN	text
Metadata	text

2other input fields

Output fields[3]

Field	Type
Reference	text
Status	text
Display Text	text
ID	number
Amount	number
Currency	text
Transaction Date	date
Domain	text
Gateway Response	text

6other output fields

Create CustomerAction

Input fields[3]

Field	Type
EmailRequired	text
First Name	text
Last Name	text
Phone	text
Metadata	text

Output fields[3]

Field	Type
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text
Phone	text
Metadata	text
Risk Action	text
International Format Phone	text

6other output fields

Create Dedicated AccountAction

Input fields[3]

Field	Type
CustomerRequired	choice
Preferred Bank	text
Subaccount	choice
Split Code	choice

Output fields[3]

Field	Type
ID	number
Account Number	text
Account Name	text
Currency	text
Bank	object
Name	text
ID	number
Slug	text
Assigned	boolean
Customer	object
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text
Split Config	object
Subaccount	text
Active	boolean

3other output fields

Create PageAction

Input fields[3]

Field	Type
NameRequired	text
Description	text
Amount	number
Slug	text
Metadata	text
Redirect URL	text
Custom Fields	array

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Amount	number
Currency	text
Slug	text
Redirect URL	text
Success Message	text
Collect Phone	boolean

10other output fields

Create Payment RequestAction

Input fields[3]

Field	Type
CustomerRequired	choice
Amount	number
Currency	text
Due Date	date
Description	text
Line Items	array
Tax	array
Send Notification	boolean
Draft	boolean

3other input fields

Output fields[3]

Field	Type
ID	number
Domain	text
Invoice Number	number
Amount	number
Discount	number
Currency	text
Due Date	date
Has Invoice	boolean
Description	text

11other output fields

Create PlanAction

Input fields[3]

Field	Type
NameRequired	text
AmountRequired	number
IntervalRequired	choice
Description	text
Send Invoices	boolean
Send SMS	boolean
Currency	choice
Invoice Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Plan Code	text
Description	text
Amount	number
Interval	text
Invoice Limit	number
Send Invoices	boolean
Send SMS	boolean

7other output fields

Create ProductAction

Input fields[3]

Field	Type
NameRequired	text
DescriptionRequired	text
PriceRequired	number
CurrencyRequired	text
Limited	boolean
Quantity	number

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Product Code	text
Price	number
Currency	text
Quantity	number
Quantity Sold	number
Type	text

8other output fields

Create RefundAction

Input fields[3]

Field	Type
TransactionRequired	text
Amount	number
Currency	choice
Customer Note	text
Merchant Note	text

Output fields[3]

Field	Type
ID	number
Transaction	object
ID	number
Reference	text
Amount	number
Currency	text
Dispute	text
Settlement	text
Amount	number
Deducted Amount	number
Currency	text
Channel	text
Fully Deducted	boolean

8other output fields

Create SplitAction

Input fields[3]

Field	Type
NameRequired	text
TypeRequired	choice
SubaccountsRequired	array
CurrencyRequired	choice
Bearer Type	choice
Bearer Subaccount	choice

Output fields[3]

Field	Type
ID	number
Name	text
Type	text
Currency	text
Domain	text
Split Code	text
Active	boolean
Bearer Type	text
Bearer Subaccount	text

5other output fields

Create SubaccountAction

Input fields[3]

Field	Type
Business NameRequired	text
Settlement BankRequired	choice
Account NumberRequired	text
Percentage ChargeRequired	number
Description	text
Primary Contact Email	text
Primary Contact Name	text
Primary Contact Phone	text
Metadata	text

Output fields[3]

Field	Type
ID	number
Subaccount Code	text
Business Name	text
Description	text
Primary Contact Name	text
Primary Contact Email	text
Primary Contact Phone	text
Metadata	text
Percentage Charge	number

11other output fields

Create SubscriptionAction

Input fields[3]

Field	Type
CustomerRequired	choice
PlanRequired	choice
Authorization	text
Start Date	date

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Subscription Code	text
Email Token	text
Amount	number
Cron Expression	text
Next Payment Date	date
Open Invoice	text

11other output fields

Create Transfer RecipientAction

Input fields[3]

Field	Type
TypeRequired	choice
NameRequired	text
Account NumberRequired	text
Bank CodeRequired	choice
Description	text
Currency	choice
Authorization Code	text
Metadata	text

Output fields[3]

Field	Type
ID	number
Active	boolean
Currency	text
Description	text
Domain	text
Metadata	text
Name	text
Recipient Code	text
Type	text

4other output fields

Deactivate AuthorizationAction

Input fields[3]

Field	Type
Authorization CodeRequired	text

Output fields[3]

Field	Type
Status	boolean
Message	text

Deactivate Dedicated AccountAction

Input fields[3]

Field	Type
Account IDRequired	number

Output fields[3]

Field	Type
Message	text

Delete ProductAction

Input fields[3]

Field	Type
IDRequired	number

Output fields[3]

Field	Type
Message	text

Delete Transfer RecipientAction

Input fields[3]

Field	Type
CodeRequired	choice

Output fields[3]

Field	Type
Message	text

Disable OTP Requirement for TransfersAction

Output fields[3]

Field	Type
Status	boolean
Message	text

Disable SubscriptionAction

Input fields[3]

Field	Type
CodeRequired	choice
TokenRequired	text

Output fields[3]

Field	Type
Status	boolean
Message	text

Enable OTP Requirement for TransfersAction

Output fields[3]

Field	Type
Status	boolean
Message	text

Enable SubscriptionAction

Input fields[3]

Field	Type
CodeRequired	choice
TokenRequired	text

Output fields[3]

Field	Type
Status	boolean
Message	text

Finalize Disable OTPAction

Input fields[3]

Field	Type
OTPRequired	text

Output fields[3]

Field	Type
Status	boolean
Message	text

Finalize Payment RequestAction

Input fields[3]

Field	Type
IDRequired	number

Output fields[3]

Field	Type
ID	number
Domain	text
Invoice Number	number
Amount	number
Currency	text
Due Date	date
Description	text
Request Code	text
Status	text

3other output fields

Finalize TransferAction

Input fields[3]

Field	Type
Transfer CodeRequired	text
OTPRequired	text

Output fields[3]

Field	Type
ID	number
Domain	text
Amount	number
Currency	text
Source	text
Source Details	text
Reason	text
Recipient	object
ID	number
Type	text
Name	text
Recipient Code	text
Details	object
Status	text

5other output fields

Generate Update Subscription LinkAction

Input fields[3]

Field	Type
CodeRequired	choice

Output fields[3]

Field	Type
Link	text

Initialize TransactionAction

Input fields[3]

Field	Type
EmailRequired	text
AmountRequired	number
Currency	choice
Reference	text
Callback URL	text
Plan	choice
Invoice Limit	number
Metadata	text
Channels	text

4other input fields

Output fields[3]

Field	Type
Authorization URL	text
Access Code	text
Reference	text

Initiate Bulk ChargeAction

Input fields[3]

Field	Type
ChargesRequired	array

Output fields[3]

Field	Type
ID	number
Batch Code	text
Reference	text
Status	text
Total Charges	number
Pending Charges	number
Created At	date
Updated At	date

Initiate Bulk TransferAction

Input fields[3]

Field	Type
SourceRequired	choice
TransfersRequired	array

Output fields[3]

Field	Type
Reference	text
Recipient	text
Amount	number
Currency	text
Status	text

Initiate TransferAction

Input fields[3]

Field	Type
SourceRequired	choice
AmountRequired	number
RecipientRequired	choice
Reason	text
Currency	choice
Reference	text

Output fields[3]

Field	Type
ID	number
Domain	text
Amount	number
Currency	text
Source	text
Source Details	text
Reason	text
Recipient	object
ID	number
Type	text
Name	text
Recipient Code	text
Details	object
Status	text

5other output fields

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Content-Type	text
Status Code	number

Partial DebitAction

Input fields[3]

Field	Type
EmailRequired	text
AmountRequired	number
Authorization CodeRequired	text
CurrencyRequired	choice
Reference	text
At Least	text

Output fields[3]

Field	Type
ID	number
Domain	text
Status	text
Reference	text
Amount	number
Message	text
Gateway Response	text
Paid At	date
Created At	date

10other output fields

Pause Bulk Charge BatchAction

Input fields[3]

Field	Type
Batch CodeRequired	text

Output fields[3]

Field	Type
ID	number
Batch Code	text
Reference	text
Status	text
Total Charges	number
Pending Charges	number
Created At	date
Updated At	date

Remove Subaccount from SplitAction

Input fields[3]

Field	Type
IDRequired	text
SubaccountRequired	choice

Output fields[3]

Field	Type
ID	number
Name	text
Type	text
Currency	text
Domain	text
Split Code	text
Active	boolean
Bearer Type	text
Bearer Subaccount	text

5other output fields

Resend OTP for TransferAction

Input fields[3]

Field	Type
Transfer CodeRequired	text
ReasonRequired	text

Output fields[3]

Field	Type
Status	boolean
Message	text

Resolve DisputeAction

Input fields[3]

Field	Type
IDRequired	text
ResolutionRequired	choice
MessageRequired	text
Refund AmountRequired	number
Uploaded FilenameRequired	text
Evidence	number

Output fields[3]

Field	Type
ID	number
Refund Amount	number
Currency	text
Status	text
Resolution	text
Transaction	object
ID	number
Reference	text
Amount	number
Currency	text
Transaction Reference	text
Category	text
Customer	object
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text

9other output fields

Resume Bulk Charge BatchAction

Input fields[3]

Field	Type
Batch CodeRequired	text

Output fields[3]

Field	Type
ID	number
Batch Code	text
Reference	text
Status	text
Total Charges	number
Pending Charges	number
Created At	date
Updated At	date

Send Payment Request NotificationAction

Input fields[3]

Field	Type
IDRequired	number

Output fields[3]

Field	Type
Message	text

Send Update Subscription EmailAction

Input fields[3]

Field	Type
CodeRequired	choice

Output fields[3]

Field	Type
Status	boolean
Message	text

Split Dedicated Account TransactionAction

Input fields[3]

Field	Type
Account NumberRequired	text
Subaccount	choice
Split Code	choice

Output fields[3]

Field	Type
ID	number
Account Number	text
Account Name	text
Currency	text
Bank	object
Name	text
ID	number
Slug	text
Assigned	boolean
Split Config	object
Subaccount	text
Active	boolean
Created At	date

1other output field

Submit AddressAction

Input fields[3]

Field	Type
AddressRequired	text
CityRequired	text
StateRequired	text
Zip CodeRequired	text
ReferenceRequired	text

Output fields[3]

Field	Type
Reference	text
Status	text
Display Text	text
ID	number
Amount	number
Currency	text
Transaction Date	date
Domain	text
Gateway Response	text

6other output fields

Submit BirthdayAction

Input fields[3]

Field	Type
BirthdayRequired	date
ReferenceRequired	text

Output fields[3]

Field	Type
Reference	text
Status	text
Display Text	text
ID	number
Amount	number
Currency	text
Transaction Date	date
Domain	text
Gateway Response	text

6other output fields

Submit OTPAction

Input fields[3]

Field	Type
OTPRequired	text
ReferenceRequired	text

Output fields[3]

Field	Type
Reference	text
Status	text
Display Text	text
ID	number
Amount	number
Currency	text
Transaction Date	date
Domain	text
Gateway Response	text

6other output fields

Submit PhoneAction

Input fields[3]

Field	Type
PhoneRequired	text
ReferenceRequired	text

Output fields[3]

Field	Type
Reference	text
Status	text
Display Text	text
ID	number
Amount	number
Currency	text
Transaction Date	date
Domain	text
Gateway Response	text

6other output fields

Submit PINAction

Input fields[3]

Field	Type
PINRequired	text
ReferenceRequired	text

Output fields[3]

Field	Type
Reference	text
Status	text
Display Text	text
ID	number
Amount	number
Currency	text
Transaction Date	date
Domain	text
Gateway Response	text

6other output fields

Update CustomerAction

Input fields[3]

Field	Type
CodeRequired	text
First Name	text
Last Name	text
Phone	text
Metadata	text

Output fields[3]

Field	Type
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text
Phone	text
Metadata	text
Risk Action	text
International Format Phone	text

6other output fields

Update DisputeAction

Input fields[3]

Field	Type
IDRequired	text
Refund AmountRequired	number
Uploaded Filename	text

Output fields[3]

Field	Type
ID	number
Refund Amount	number
Currency	text
Status	text
Resolution	text
Transaction	object
ID	number
Reference	text
Amount	number
Currency	text
Transaction Reference	text
Category	text
Customer	object
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text

9other output fields

Update PageAction

Input fields[3]

Field	Type
IDRequired	number
Name	text
Description	text
Amount	number
Active	boolean
Redirect URL	text
Metadata	text
Custom Fields	array

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Amount	number
Currency	text
Slug	text
Redirect URL	text
Success Message	text
Collect Phone	boolean

10other output fields

Update Payment RequestAction

Input fields[3]

Field	Type
IDRequired	number
Customer	choice
Amount	number
Currency	text
Due Date	date
Description	text
Line Items	array
Tax	array
Send Notification	boolean

3other input fields

Output fields[3]

Field	Type
ID	number
Domain	text
Invoice Number	number
Amount	number
Discount	number
Currency	text
Due Date	date
Has Invoice	boolean
Description	text

11other output fields

Update Payment Session TimeoutAction

Input fields[3]

Field	Type
TimeoutRequired	number

Output fields[3]

Field	Type
Payment Session Timeout	number

Update PlanAction

Input fields[3]

Field	Type
CodeRequired	text
Name	text
Amount	number
Interval	choice
Description	text
Send Invoices	boolean
Send SMS	boolean
Currency	choice
Invoice Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Plan Code	text
Description	text
Amount	number
Interval	text
Invoice Limit	number
Send Invoices	boolean
Send SMS	boolean

7other output fields

Update ProductAction

Input fields[3]

Field	Type
IDRequired	number
Name	text
Description	text
Price	number
Currency	text
Limited	boolean
Quantity	number

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Product Code	text
Price	number
Currency	text
Quantity	number
Quantity Sold	number
Type	text

8other output fields

Update SplitAction

Input fields[3]

Field	Type
IDRequired	text
Name	text
Active	boolean
Bearer Type	choice
Bearer Subaccount	choice

Output fields[3]

Field	Type
ID	number
Name	text
Type	text
Currency	text
Domain	text
Split Code	text
Active	boolean
Bearer Type	text
Bearer Subaccount	text

5other output fields

Update SubaccountAction

Input fields[3]

Field	Type
CodeRequired	choice
Business Name	text
Settlement Bank	choice
Account Number	text
Active	boolean
Percentage Charge	number
Description	text
Primary Contact Email	text
Primary Contact Name	text

2other input fields

Output fields[3]

Field	Type
ID	number
Subaccount Code	text
Business Name	text
Description	text
Primary Contact Name	text
Primary Contact Email	text
Primary Contact Phone	text
Metadata	text
Percentage Charge	number

11other output fields

Update Transfer RecipientAction

Input fields[3]

Field	Type
CodeRequired	choice
Name	text
Email	text

Output fields[3]

Field	Type
ID	number
Active	boolean
Currency	text
Description	text
Domain	text
Metadata	text
Name	text
Recipient Code	text
Type	text

4other output fields

Validate CustomerAction

Input fields[3]

Field	Type
CodeRequired	text
CountryRequired	text
TypeRequired	text
ValueRequired	text
Account Number	text
BVN	text
Bank Code	text
First Name	text
Last Name	text

1other input field

Output fields[3]

Field	Type
Status	boolean
Message	text

White/blacklist CustomerAction

Input fields[3]

Field	Type
CustomerRequired	text
Risk ActionRequired	choice

Output fields[3]

Field	Type
ID	number
First Name	text
Last Name	text
Email	text
Customer Code	text
Phone	text
Metadata	text
Risk Action	text
International Format Phone	text

6other output fields

Templates

Look for Paystack templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Finance category →

References

WEXTL® Paystack Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Paystack.
WEXTL® visual workflow builder data.

Last updated: Sep 5, 2026 10:04

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.