Requirements
Connecting Korapay takes an active account plus an API access token from your account settings — no other setup is required.[3]
Get your Korapay credentials
- API KeypasswordRequired
Log in to your Dashboard, go to Developers → API Keys, and click Generate API Key to obtain your API key.
[1]
Connect Korapay in WEXTL
- Log in to your WEXTL account, add the Korapay node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Korapay 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 →
Korapay node modules
The list below is a reference of every Korapay node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any Korapay node module below to see exactly what it takes in, what it returns, and what connection it needs.
Output fields[3]
| Field | Type |
|---|---|
Reference | text |
Type | text |
First six | text |
Last four | text |
Brand | text |
Pan | text |
Cvv | text |
Expiry month | text |
Expiry year | text |
Currency | text |
Balance | number |
Status | text |
Holder name | text |
Merchant name | text |
Label | text |
Date created | date |
Output fields[3]
| Field | Type |
|---|---|
Source currency | text |
Destination currency | text |
Exchange rate | text |
Source amount | text |
Converted amount | text |
Status | text |
Reference | text |
Channel | text |
Customer name | text |
Customer email | |
Narration | text |
Transaction date | date |
Account | object |
Name | text |
Email |
Output fields[3]
| Field | Type |
|---|---|
Pointer | text |
Reference | text |
Status | text |
Amount | text |
Currency | text |
Payment reference | text |
Reason | text |
Transaction amount | text |
Created at | date |
Completed at | date |
Output fields[3]
| Field | Type |
|---|---|
Pointer | text |
Reference | text |
Status | text |
Amount | text |
Fee | text |
Currency | text |
Narration | text |
Trace ID | text |
Message | text |
Payment destination | text |
Customer name | text |
Customer email | |
Date created | date |
Date completed | date |
Input fields[3]
| Field | Type |
|---|---|
ReferenceRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
Reference | text |
Type | text |
First six | text |
Last four | text |
Brand | text |
Pan | text |
Cvv | text |
Expiry month | text |
Expiry year | text |
Currency | text |
Balance | number |
Status | text |
Billing | object |
Address 1 | text |
City | text |
State | text |
Country | text |
Zip code | text |
Card holder | object |
First name | text |
Last name | text |
Email | text |
Address | object |
Date created | date |
Category | text |
Input fields[3]
| Field | Type |
|---|---|
Account holder referenceRequired | text |
Output fields[3]
| Field | Type |
|---|---|
Reference | text |
Account type | text |
First name | text |
Last name | text |
Email | |
Phone number | text |
Occupation | text |
Status | text |
Metadata | object |
Key 1 | text |
Date created | date |
Country | text |
Date of birth | date |
Address | object |
Zip | text |
City | text |
State | text |
Address | text |
Country | text |
Documents | object |
Identification front | text |
Identification back | text |
Proof of address | text |
Selfie | text |
Source of inflow | text |
Output fields[3]
| Field | Type |
|---|---|
Ngn | object |
Pending balance | number |
Available balance | number |
Usd | object |
Pending balance | number |
Available balance | number |
Issuing balance | number |
Input fields[3]
| Field | Type |
|---|---|
Date To | date |
Date From | date |
Limit | number |
Output fields[3]
| Field | Type |
|---|---|
Source currency | text |
Destination currency | text |
Exchange rate | text |
Source amount | text |
Converted amount | text |
Status | text |
Reference | text |
Channel | text |
Customer name | text |
Customer email | |
Narration | text |
Transaction date | date |
Account | object |
Name | text |
Email |
Input fields[3]
| Field | Type |
|---|---|
Account nameRequired | text |
AmountRequired | number |
Currency | text |
Reference | text |
Customer | object |
Name | text |
Email |
Output fields[3]
| Field | Type |
|---|---|
Currency | text |
Amount | number |
Amount expected | number |
Fee | number |
Vat | number |
Reference | text |
Payment reference | text |
Status | text |
Narration | text |
Merchant bears cost | boolean |
Bank account | object |
Account name | text |
Account number | text |
Bank name | text |
Bank code | text |
Expiry date in utc | date |
Customer | object |
Name | text |
Email | text |
Input fields[3]
| Field | Type |
|---|---|
AmountRequired | number |
Currency | text |
Merchant Bears Cost | boolean |
Notification URL | url |
Description | text |
Reference | text |
Voucher | object |
PIN | text |
Phone Number | text |
Provider Code | text |
Customer | object |
Email | |
Name | text |
Metadata | array |
Output fields[3]
| Field | Type |
|---|---|
Currency | text |
Amount | number |
Fee | number |
Vat | number |
Transaction reference | text |
Payment reference | text |
Status | text |
Voucher | object |
Serial number | text |
Balance | number |
Pin | text |
Expiry date | text |
Customer | object |
Name | text |
Email | text |
Input fields[3]
| Field | Type |
|---|---|
Rate ReferenceRequired | text |
AmountRequired | number |
From CurrencyRequired | text |
To CurrencyRequired | text |
Customer NameRequired | text |
Customer Email | |
Narration | text |
Output fields[3]
| Field | Type |
|---|---|
Converted amount | text |
Source amount | text |
Destination currency | text |
Exchange rate | text |
Reference | text |
Source currency | text |
Status | text |
Input fields[3]
| Field | Type |
|---|---|
First nameRequired | text |
Last nameRequired | text |
EmailRequired | |
Phone numberRequired | text |
GenderRequired | choice |
Selfie referenceRequired | text |
Date of birthRequired | date |
Country identityRequired | object |
TypeRequired | choice |
NumberRequired | text |
CountryRequired | text |
IdentityRequired | object |
TypeRequired | choice |
NumberRequired | text |
CountryRequired | text |
Front ID referenceRequired | text |
Back ID referenceRequired | text |
Image | text |
AddressRequired | object |
StreetRequired | text |
CityRequired | text |
StateRequired | text |
CountryRequired | text |
ZIP codeRequired | text |
Street 2 | text |
Output fields[3]
| Field | Type |
|---|---|
Reference | text |
Validation status | text |
First name | text |
Last name | text |
Email | |
Phone number | text |
Date of birth | date |
Selfie reference | text |
Address | object |
Street | text |
City | text |
State | text |
Country | text |
Zip code | text |
Country identity | object |
Type | text |
Country | text |
Number | text |
Identity | object |
Type | text |
Number | text |
Country | text |
ID front reference | text |
ID back reference | text |
Input fields[3]
| Field | Type |
|---|---|
First nameRequired | text |
Last nameRequired | text |
Use caseRequired | text |
Type | text |
Date of birth | date |
Nationality | text |
Occupation | text |
Email | |
Phone | text |
Bank ID number | text |
Source of inflow | text |
Source of inflow document | object |
Reference | text |
Selfie | object |
Reference | text |
Identification | object |
Type | text |
Number | text |
Document front | object |
Issued date | date |
Expiry date | date |
Country | text |
Proof of address | object |
Type | text |
Document | object |
Address | object |
Country | text |
ZIP | text |
Address | text |
State | text |
City | text |
Employment | object |
Status | text |
Employer | text |
Description | text |
Metadata | array |
Output fields[3]
| Field | Type |
|---|---|
Reference | text |
Email | |
Status | text |
Metadata | object |
Key 1 | text |
Input fields[3]
| Field | Type |
|---|---|
Account nameRequired | text |
Account referenceRequired | text |
Permanent | boolean |
Bank code | text |
Customer | object |
Name | text |
Email | |
KYC | object |
BVN | text |
Output fields[3]
| Field | Type |
|---|---|
Account name | text |
Account number | text |
Bank code | text |
Bank name | text |
Account reference | text |
Unique ID | text |
Account status | text |
Created at | date |
Currency | text |
Customer | object |
Name | text |
Input fields[3]
| Field | Type |
|---|---|
Batch Reference | text |
Description | text |
Merchant Bears Cost | boolean |
Currency | text |
Payouts | array |
Reference | text |
Amount | number |
Type | text |
Narration | text |
Bank Account | object |
Customer | object |
Output fields[3]
| Field | Type |
|---|---|
Status | text |
Total chargeable amount | number |
Merchant bears cost | boolean |
Currency | text |
Reference | text |
Description | text |
Created at | date |
Input fields[3]
| Field | Type |
|---|---|
TypeRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
CustomerRequired | object |
EmailRequired | |
Name | text |
Bank AccountRequired | object |
BankRequired | text |
AccountRequired | text |
Account NameRequired | text |
Bank NameRequired | text |
Beneficiary TypeRequired | choice |
First NameRequired | text |
Last NameRequired | text |
Business NameRequired | text |
Account TypeRequired | choice |
Account Number TypeRequired | choice |
Mobile MoneyRequired | object |
OperatorRequired | text |
Mobile NumberRequired | text |
Supporting DocumentsRequired | array |
TitleRequired | text |
File ReferenceRequired | text |
Narration | text |
Purpose of Payment | text |
Bank CountryRequired | text |
Reference | text |
Metadata | array |
Output fields[3]
| Field | Type |
|---|---|
Amount | text |
Fee | text |
Currency | text |
Status | text |
Reference | text |
Narration | text |
Customer | object |
Name | text |
Email | |
Phone | text |
Input fields[3]
| Field | Type |
|---|---|
ReferenceRequired | text |
TypeRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
CryptoRequired | object |
NetworkRequired | text |
Destination AddressRequired | text |
CustomerRequired | object |
EmailRequired | |
Name | text |
Narration | text |
Output fields[3]
| Field | Type |
|---|---|
Amount | text |
Fee | text |
Currency | text |
Status | text |
Reference | text |
Narration | text |
Customer | object |
Name | text |
Email | |
Phone | text |
Input fields[3]
| Field | Type |
|---|---|
ReferenceRequired | text |
TypeRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
Mobile MoneyRequired | object |
OperatorRequired | text |
Mobile NumberRequired | text |
CustomerRequired | object |
EmailRequired | |
Name | text |
Narration | text |
Output fields[3]
| Field | Type |
|---|---|
Amount | text |
Fee | text |
Currency | text |
Status | text |
Reference | text |
Narration | text |
Customer | object |
Name | text |
Email | |
Phone | text |
Input fields[3]
| Field | Type |
|---|---|
ReferenceRequired | text |
DestinationRequired | object |
TypeRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
Bank accountRequired | object |
CustomerRequired | object |
Narration | text |
Remittance dataRequired | object |
Sender nameRequired | text |
Sender phone number | text |
Sender date of birth | date |
Sender country ISO | text |
Sender nationality | text |
Sender ID type | text |
Sender ID number | text |
Sender service provider name | text |
Remittance purpose | text |
Sender-recipient relationship | text |
Output fields[3]
| Field | Type |
|---|---|
Amount | text |
Fee | text |
Currency | text |
Status | text |
Reference | text |
Narration | text |
Customer | object |
Name | text |
Email | text |
Phone | text |
Input fields[3]
| Field | Type |
|---|---|
ReferenceRequired | text |
DestinationRequired | object |
TypeRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
Narration | text |
Mobile moneyRequired | object |
CustomerRequired | object |
Remittance dataRequired | object |
Sender nameRequired | text |
Sender phone number | text |
Sender date of birth | date |
Sender country ISO code | text |
Sender nationality | text |
Sender ID type | text |
Sender ID number | text |
Sender service provider name | text |
Remittance purpose | text |
Sender-recipient relationship | text |
Output fields[3]
| Field | Type |
|---|---|
Amount | text |
Fee | text |
Currency | text |
Status | text |
Reference | text |
Narration | text |
Customer | object |
Name | text |
Email | text |
Phone | text |
Input fields[3]
| Field | Type |
|---|---|
Cardholder ReferenceRequired | choice |
First name | text |
Last name | text |
Email | |
Phone number | text |
Gender | choice |
Selfie reference | text |
Date of birth | date |
Country identity | object |
Type | choice |
Number | text |
Country | text |
Identity | object |
Type | choice |
Number | text |
Country | text |
Front ID reference | text |
Back ID reference | text |
Image | text |
Address | object |
Street | text |
City | text |
State | text |
Country | text |
ZIP code | text |
Street 2 | text |
Output fields[3]
| Field | Type |
|---|---|
Status | boolean |
Message | text |
Input fields[3]
| Field | Type |
|---|---|
Account holder referenceRequired | text |
First name | text |
Last name | text |
Use case | text |
Type | text |
Date of birth | date |
Nationality | text |
Occupation | text |
Email | |
Phone | text |
Bank ID number | text |
Source of inflow | text |
Source of inflow document | object |
Reference | text |
Selfie | object |
Reference | text |
Identification | object |
Type | text |
Number | text |
Document front | object |
Issued date | date |
Expiry date | date |
Country | text |
Proof of address | object |
Type | text |
Document | object |
Address | object |
Country | text |
ZIP | text |
Address | text |
State | text |
City | text |
Employment | object |
Status | text |
Employer | text |
Description | text |
Metadata | array |
Output fields[3]
| Field | Type |
|---|---|
Reference | text |
Email | |
Status | text |
Metadata | object |
Key 1 | text |
Templates
Look for Korapay templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Checkout[2]Global payment platform for accepting cards, wallets, and alternative payment methods.
- BlueSnapGlobal payment gateway for accepting cards, local payment methods, and managing subscriptions.
- CoinbaseCryptocurrency exchange and payments platform for trading, transfers, and digital asset orders.
- CapiumCloud accounting and practice management platform for accountants, covering invoicing, expenses, payments, and client communications.
- BillogramDigital invoicing and billing platform that sends invoices and collects payments from customers.
References
- WEXTL® Korapay Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Korapay.
- WEXTL® visual workflow builder data.
Last updated: Oct 7, 2026 00:18