About this integration
Process payments, manage customers, handle subscriptions, and disburse transfers across Africa. Connect it to any workflow without writing code.
You can choose from 7 triggers, 58 search modules and 63 actions. The connection type is basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for Secret Key.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
Secret KeyRequired | password | 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. |
Use it in workflow automation
Start with Watch New Customers, then add Add Dispute Evidence.
Triggers, searches and actions
Explore the fields available for each Paystack trigger, search, and action — 7 triggers, 58 searchs, and 63 actions.
Triggers
Whenever something changes in the app, one of 7 available triggers can start a run immediately.
- Watch New Customers
- Watch New Disputes
- Watch New Plans
- Watch New Refunds
- Watch New Transactions
2more triggers
Searches
58 search modules let you query the app mid-run and feed the results to the next step.
- Balance Ledger
- Check Pending Charge
- Check Slug Availability
- Export Disputes
- Export Transactions
53more searches
Actions
Use 63 action modules to write data back into the app from anywhere in a run.
- Add Dispute Evidence
- Add Products to Page
- Add Subaccount to Split
- Archive Payment Request
- Bulk Create Transfer Recipient
58more actions
Explore the fields available for each Paystack trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
ID | number |
First Name | text |
Last Name | text |
Email | |
Customer Code | text |
Phone | text |
Metadata | text |
Risk Action | text |
Domain | text |
3other output fields
Output fields
| 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 | |
Customer Code | text |
Due At | date |
3other output fields
Output fields
| 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
Output fields
| 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
Output fields
| 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
Output fields
| 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
Output fields
| 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 |
Searches
Input fields
| Field | Type |
|---|---|
From | date |
To | date |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
ReferenceRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
SlugRequired | text |
Output fields
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Input fields
| Field | Type |
|---|---|
Per Page | number |
Page | number |
From | date |
To | date |
Status | choice |
Output fields
| Field | Type |
|---|---|
Download URL | url |
Input fields
| 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
| Field | Type |
|---|---|
Path | text |
Expires At | date |
Input fields
| Field | Type |
|---|---|
Per Page | number |
Page | number |
Status | choice |
From | date |
To | date |
Output fields
| Field | Type |
|---|---|
Path | text |
Expires At | date |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Currency | text |
Balance | number |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Provider Slug | text |
Bank ID | text |
Bank Name | text |
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Batch CodeRequired | text |
Output fields
| Field | Type |
|---|---|
ID | number |
Batch Code | text |
Reference | text |
Status | text |
Total Charges | number |
Pending Charges | number |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
Batch CodeRequired | text |
Status | text |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
CodeRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Account IDRequired | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | number |
Output fields
| 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
Output fields
| Field | Type |
|---|---|
Payment Session Timeout | number |
Input fields
| Field | Type |
|---|---|
CodeRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
From | date |
To | date |
Subaccount | choice |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
CodeRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Transaction ID or ReferenceRequired | text |
Output fields
| Field | Type |
|---|---|
History | array |
Input fields
| Field | Type |
|---|---|
CodeRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | number |
Active | boolean |
Currency | text |
Description | text |
Domain | text |
Metadata | text |
Name | text |
Recipient Code | text |
Type | text |
4other output fields
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Upload FilenameRequired | text |
Output fields
| Field | Type |
|---|---|
Signed URL | url |
File Name | text |
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Output fields
| Field | Type |
|---|---|
Message | text |
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Output fields
| Field | Type |
|---|---|
Message | text |
Input fields
| Field | Type |
|---|---|
From | date |
To | date |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | number |
Batch Code | text |
Reference | text |
Status | text |
Total Charges | number |
Pending Charges | number |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | number |
Name | text |
ISO Code | text |
Default Currency Code | text |
Input fields
| Field | Type |
|---|---|
Use Cursor | boolean |
Next Cursor | text |
Previous Cursor | text |
From | date |
To | date |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Account Number | text |
Active | boolean |
Currency | text |
Provider Slug | text |
Bank ID | text |
Customer | text |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
From | date |
To | date |
Status | choice |
Transaction | text |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Customer | text |
Status | choice |
Currency | text |
Include Archive | boolean |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Interval | choice |
Amount | number |
From | date |
To | date |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
From | date |
To | date |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Name | text |
Active | boolean |
Sort By | text |
From | date |
To | date |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Country | text |
Type | text |
Currency | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Name | text |
Slug | text |
Abbreviation | text |
Input fields
| Field | Type |
|---|---|
From | date |
To | date |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Customer | text |
Plan | text |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
From | date |
To | date |
Customer | text |
Status | choice |
Amount | number |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
From | date |
To | date |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | number |
Active | boolean |
Currency | text |
Description | text |
Domain | text |
Metadata | text |
Name | text |
Recipient Code | text |
Type | text |
4other output fields
Input fields
| Field | Type |
|---|---|
From | date |
To | date |
Status | choice |
Limit | number |
Output fields
| 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
Output fields
| Field | Type |
|---|---|
Pending | array |
Successful | array |
Total | array |
Input fields
| Field | Type |
|---|---|
Account NumberRequired | text |
Bank CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
Account Number | text |
Account Name | text |
Bank ID | number |
Input fields
| Field | Type |
|---|---|
BVNRequired | text |
Output fields
| Field | Type |
|---|---|
BVN | text |
First Name | text |
Last Name | text |
Date of Birth | text |
Input fields
| Field | Type |
|---|---|
BINRequired | text |
Output fields
| Field | Type |
|---|---|
BIN | text |
Brand | text |
Sub Brand | text |
Country Code | text |
Country Name | text |
Card Type | text |
Bank | text |
Linked Bank ID | number |
Input fields
| Field | Type |
|---|---|
IDRequired | text |
From | date |
To | date |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | number |
Reference | text |
Amount | number |
Currency | text |
Status | text |
Paid At | date |
Channel | text |
Input fields
| Field | Type |
|---|---|
From | date |
To | date |
Output fields
| Field | Type |
|---|---|
Total Transactions | number |
Total Volume | number |
Total Volume By Currency | array |
Pending Transfers | number |
Pending Transfers By Currency | array |
Input fields
| Field | Type |
|---|---|
IDRequired | number |
Output fields
| Field | Type |
|---|---|
ID | number |
Request Code | text |
Status | text |
Paid | boolean |
Paid At | date |
Amount | number |
Currency | text |
Due Date | date |
Input fields
| Field | Type |
|---|---|
ReferenceRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
ReferenceRequired | text |
Output fields
| 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
Actions
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Customer EmailRequired | text |
Customer NameRequired | text |
Customer PhoneRequired | text |
Service DetailsRequired | text |
Delivery Address | text |
Delivery Date | date |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | number |
ProductsRequired | choice |
Output fields
| Field | Type |
|---|---|
Message | text |
Input fields
| Field | Type |
|---|---|
IDRequired | text |
SubaccountRequired | choice |
ShareRequired | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | number |
Output fields
| Field | Type |
|---|---|
Message | text |
Input fields
| Field | Type |
|---|---|
BatchRequired | array |
Output fields
| Field | Type |
|---|---|
Success | array |
Errors | array |
Input fields
| Field | Type |
|---|---|
BVNRequired | text |
Account NumberRequired | text |
Bank CodeRequired | choice |
First Name | text |
Middle Name | text |
Last Name | text |
Output fields
| Field | Type |
|---|---|
BVN | text |
First Name | text |
Last Name | text |
Middle Name | text |
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
EmailRequired | text |
AmountRequired | number |
Authorization CodeRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
EmailRequired | |
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
| 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
Input fields
| Field | Type |
|---|---|
EmailRequired | text |
First Name | text |
Last Name | text |
Phone | text |
Metadata | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Preferred Bank | text |
Subaccount | choice |
Split Code | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Description | text |
Amount | number |
Slug | text |
Metadata | text |
Redirect URL | text |
Custom Fields | array |
Output fields
| 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
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
NameRequired | text |
AmountRequired | number |
IntervalRequired | choice |
Description | text |
Send Invoices | boolean |
Send SMS | boolean |
Currency | choice |
Invoice Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
NameRequired | text |
DescriptionRequired | text |
PriceRequired | number |
CurrencyRequired | text |
Limited | boolean |
Quantity | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
TransactionRequired | text |
Amount | number |
Currency | choice |
Customer Note | text |
Merchant Note | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
NameRequired | text |
TypeRequired | choice |
SubaccountsRequired | array |
CurrencyRequired | choice |
Bearer Type | choice |
Bearer Subaccount | choice |
Output fields
| 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
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
PlanRequired | choice |
Authorization | text |
Start Date | date |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
TypeRequired | choice |
NameRequired | text |
Account NumberRequired | text |
Bank CodeRequired | choice |
Description | text |
Currency | choice |
Authorization Code | text |
Metadata | text |
Output fields
| Field | Type |
|---|---|
ID | number |
Active | boolean |
Currency | text |
Description | text |
Domain | text |
Metadata | text |
Name | text |
Recipient Code | text |
Type | text |
4other output fields
Input fields
| Field | Type |
|---|---|
Authorization CodeRequired | text |
Output fields
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Input fields
| Field | Type |
|---|---|
Account IDRequired | number |
Output fields
| Field | Type |
|---|---|
Message | text |
Input fields
| Field | Type |
|---|---|
IDRequired | number |
Output fields
| Field | Type |
|---|---|
Message | text |
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
Message | text |
Output fields
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
TokenRequired | text |
Output fields
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Output fields
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
TokenRequired | text |
Output fields
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Input fields
| Field | Type |
|---|---|
OTPRequired | text |
Output fields
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Input fields
| Field | Type |
|---|---|
IDRequired | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Transfer CodeRequired | text |
OTPRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
Link | text |
Input fields
| 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
| Field | Type |
|---|---|
Authorization URL | text |
Access Code | text |
Reference | text |
Input fields
| Field | Type |
|---|---|
ChargesRequired | array |
Output fields
| Field | Type |
|---|---|
ID | number |
Batch Code | text |
Reference | text |
Status | text |
Total Charges | number |
Pending Charges | number |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
SourceRequired | choice |
TransfersRequired | array |
Output fields
| Field | Type |
|---|---|
Reference | text |
Recipient | text |
Amount | number |
Currency | text |
Status | text |
Input fields
| Field | Type |
|---|---|
SourceRequired | choice |
AmountRequired | number |
RecipientRequired | choice |
Reason | text |
Currency | choice |
Reference | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | object |
Content-Type | text |
Status Code | number |
Input fields
| Field | Type |
|---|---|
EmailRequired | text |
AmountRequired | number |
Authorization CodeRequired | text |
CurrencyRequired | choice |
Reference | text |
At Least | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Batch CodeRequired | text |
Output fields
| Field | Type |
|---|---|
ID | number |
Batch Code | text |
Reference | text |
Status | text |
Total Charges | number |
Pending Charges | number |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
IDRequired | text |
SubaccountRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Transfer CodeRequired | text |
ReasonRequired | text |
Output fields
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Input fields
| Field | Type |
|---|---|
IDRequired | text |
ResolutionRequired | choice |
MessageRequired | text |
Refund AmountRequired | number |
Uploaded FilenameRequired | text |
Evidence | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Batch CodeRequired | text |
Output fields
| Field | Type |
|---|---|
ID | number |
Batch Code | text |
Reference | text |
Status | text |
Total Charges | number |
Pending Charges | number |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
IDRequired | number |
Output fields
| Field | Type |
|---|---|
Message | text |
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Input fields
| Field | Type |
|---|---|
Account NumberRequired | text |
Subaccount | choice |
Split Code | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
AddressRequired | text |
CityRequired | text |
StateRequired | text |
Zip CodeRequired | text |
ReferenceRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
BirthdayRequired | date |
ReferenceRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
OTPRequired | text |
ReferenceRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
PhoneRequired | text |
ReferenceRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
PINRequired | text |
ReferenceRequired | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
CodeRequired | text |
First Name | text |
Last Name | text |
Phone | text |
Metadata | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Refund AmountRequired | number |
Uploaded Filename | text |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | number |
Name | text |
Description | text |
Amount | number |
Active | boolean |
Redirect URL | text |
Metadata | text |
Custom Fields | array |
Output fields
| 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
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
TimeoutRequired | number |
Output fields
| Field | Type |
|---|---|
Payment Session Timeout | number |
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | number |
Name | text |
Description | text |
Price | number |
Currency | text |
Limited | boolean |
Quantity | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
IDRequired | text |
Name | text |
Active | boolean |
Bearer Type | choice |
Bearer Subaccount | choice |
Output fields
| 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
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
Name | text |
Email | text |
Output fields
| Field | Type |
|---|---|
ID | number |
Active | boolean |
Currency | text |
Description | text |
Domain | text |
Metadata | text |
Name | text |
Recipient Code | text |
Type | text |
4other output fields
Input fields
| 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
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Input fields
| Field | Type |
|---|---|
CustomerRequired | text |
Risk ActionRequired | choice |
Output fields
| 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