Requirements
Connecting onPay takes an active account plus OAuth client credentials, granted by signing in with your account — no other setup is required.[3]
Get your onPay credentials
Credential type option 1
onPay oAuth
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- OnPay - Client ID / Registration Owner Domaintext
Client ID must be set to the domain name of the integration owner. Example values: yourcompany.com.
[1]
Credential type option 2
onPay API Token
- OnPay - API TokenpasswordRequired
Generate an API token in the management panel under Settings → API.
[1]
Connect onPay in WEXTL
- Log in to your WEXTL account, add the onPay 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 onPay 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 →
onPay node modules
The list below is a reference of every onPay node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any onPay node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch SubscriptionsTrigger
Output fields[3]
| Field | Type |
|---|---|
| 3dsecure | boolean |
| Acquirer | text |
| Card type | text |
| Created | text |
| Currency code | number |
| Order ID | text |
| Status | text |
| Subscription number | number |
| UUID | text |
| Wallet | text |
| Testmode | boolean |
| Links | object |
| Self | text |
Watch Transaction EventsTrigger
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Transaction | text |
| Date time | date |
| Action | text |
| Successful | boolean |
| Amount | number |
| Result code | text |
| Result text | text |
| Author | text |
| IP | text |
| Links | object |
| Transaction | text |
Watch TransactionsTrigger
Output fields[3]
| Field | Type |
|---|---|
| 3dsecure | boolean |
| Acquirer | text |
| Amount | number |
| Card type | text |
| Charged | number |
| Created | date |
| Currency code | number |
| Order ID | text |
| Refunded | number |
| Status | text |
| Transaction number | number |
| UUID | text |
| Wallet | text |
| Testmode | boolean |
| Links | object |
| Self | text |
Get a SubscriptionAction
Get a TransactionAction
Input fields[3]
| Field | Type |
|---|---|
Transaction UUID or Transaction NumberRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| 3dsecure | boolean |
| Acquirer | text |
| Amount | number |
| Card bin | text |
| Card mask | text |
| Card type | text |
| Card country | number |
| Charged | number |
| Created | date |
| Currency code | number |
| Expiry month | number |
| Expiry year | number |
| IP | text |
| IP country | number |
| Order ID | text |
| Refunded | number |
| Status | text |
| Subscription number | number |
| Subscription UUID | text |
| Transaction number | number |
6other output fields
Get an AcquirerAction
List AcquirersSearch
List ProvidersSearch
List SubscriptionsSearch
Input fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Order ID or Subscription Number | text |
| Order By | choice |
| Sort Direction | choice |
| Date After | date |
| Date Before | date |
| Maximum number of subscriptions | number |
Output fields[3]
| Field | Type |
|---|---|
| 3dsecure | boolean |
| Acquirer | text |
| Card type | text |
| Created | date |
| Currency code | number |
| Order ID | text |
| Status | text |
| Subscription number | number |
| UUID | text |
| Wallet | text |
| Testmode | boolean |
| Links | object |
| Self | text |
List Transaction EventsSearch
List TransactionsSearch
Input fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Order ID or Transaction Number | text |
| Order By | choice |
| Sort Direction | choice |
| Date After | date |
| Date Before | date |
| Maximum number of transactions | number |
Output fields[3]
| Field | Type |
|---|---|
| 3dsecure | boolean |
| Acquirer | text |
| Amount | number |
| Card type | text |
| Charged | number |
| Created | date |
| Currency code | number |
| Order ID | text |
| Refunded | number |
| Status | text |
| Transaction number | number |
| UUID | text |
| Wallet | text |
| Testmode | boolean |
| Links | object |
| Self | text |
Cancel a SubscriptionAction
Input fields[3]
| Field | Type |
|---|---|
Subscription UUID or Subscription NumberRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| 3dsecure | boolean |
| Acquirer | text |
| Card bin | text |
| Card type | text |
| Created | date |
| Currency code | number |
| Expiry month | number |
| Expiry year | number |
| IP | text |
| Order ID | text |
| Status | text |
| Subscription number | number |
| UUID | text |
| Wallet | text |
| Testmode | boolean |
| History | array |
| Transactions | array |
Cancel a TransactionAction
Input fields[3]
| Field | Type |
|---|---|
Transaction UUID or Transaction NumberRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| 3dsecure | boolean |
| Acquirer | text |
| Amount | number |
| Card bin | text |
| Card type | text |
| Charged | number |
| Created | text |
| Currency code | number |
| Expiry month | number |
| Expiry year | number |
| IP | text |
| Order ID | text |
| Refunded | number |
| Status | text |
| Subscription number | number |
| Subscription UUID | text |
| Transaction number | number |
| UUID | text |
| Wallet | text |
| Has cardholder data | boolean |
3other output fields
Capture a TransactionAction
Input fields[3]
| Field | Type |
|---|---|
Transaction IDRequired | choice |
| Capture Type | choice |
Output fields[3]
| Field | Type |
|---|---|
| 3dsecure | boolean |
| Acquirer | text |
| Amount | number |
| Card bin | text |
| Card type | text |
| Charged | number |
| Created | date |
| Currency code | number |
| Expiry month | number |
| Expiry year | number |
| IP | text |
| Order ID | text |
| Refunded | number |
| Status | text |
| Subscription number | number |
| Subscription UUID | text |
| Transaction number | number |
| UUID | text |
| Wallet | text |
| Has cardholder data | boolean |
3other output fields
Create a PaymentAction
Input fields[3]
| Field | Type |
|---|---|
CurrencyRequired | text |
AmountRequired | number |
ReferenceRequired | text |
WebsiteRequired | url |
| Accept URL | url |
| Type | choice |
| Method | choice |
| Surcharge Enabled | boolean |
| Surcharge VAT Rate | number |
| Language | choice |
| Decline URL | url |
| Callback URL | url |
| Design | text |
| Expiration | date |
| Create Transaction on Completion | boolean |
| Test Mode | boolean |
| Info | object |
| Name | text |
| Account | object |
| Billing | object |
| Shipping | object |
| Phone | object |
| Address Identical to Shipping | choice |
| Delivery Email | |
| Delivery Time Frame | text |
| Gift Card Amount | number |
| Cart | object |
| Shipping | object |
| Handling | object |
| Cart Discount | number |
| Items | array |
Output fields[3]
| Field | Type |
|---|---|
| Payment UUID | text |
| Amount | number |
| Currency code | text |
| Expiration | date |
| Language | text |
| Method | text |
Create a Transaction From a SubscriptionAction
Input fields[3]
| Field | Type |
|---|---|
Subscription UUID or Subscription NumberRequired | choice |
Amount (Minor Units)Required | number |
Order IDRequired | text |
| Surcharge Enabled | boolean |
| Surcharge VAT Rate | number |
Output fields[3]
| Field | Type |
|---|---|
| 3dsecure | boolean |
| Acquirer | text |
| Amount | number |
| Card bin | text |
| Card type | text |
| Charged | number |
| Created | text |
| Currency code | number |
| Expiry month | number |
| Expiry year | number |
| IP | text |
| Order ID | text |
| Refunded | number |
| Status | text |
| Subscription number | number |
| Subscription UUID | text |
| Transaction number | number |
| UUID | text |
| Wallet | text |
| Has cardholder data | boolean |
4other output fields
Make an API Calluniversal
Refund a TransactionAction
Input fields[3]
| Field | Type |
|---|---|
Transaction IDRequired | choice |
| Refund Type | choice |
Output fields[3]
| Field | Type |
|---|---|
| 3dsecure | boolean |
| Acquirer | text |
| Amount | number |
| Card bin | text |
| Card type | text |
| Charged | number |
| Created | text |
| Currency code | number |
| Expiry month | number |
| Expiry year | number |
| IP | text |
| Order ID | text |
| Refunded | number |
| Status | text |
| Subscription number | number |
| Subscription UUID | text |
| Transaction number | number |
| UUID | text |
| Wallet | text |
| Has cardholder data | boolean |
3other output fields
Update an AcquirerAction
Input fields[3]
| Field | Type |
|---|---|
AcquirerRequired | choice |
| Acquirer Settings | object |
| Active | boolean |
| MCC | text |
| TOF | text |
| SCA Mode | choice |
| SCA Exemptions | object |
| Customer Number | text |
| API Key | text |
| Amex ID | text |
| International Merchant ID | text |
| Mastercard BIN | text |
Output fields[3]
| Field | Type |
|---|---|
| Name | text |
| Active | boolean |
| Amex ID | text |
| Exemptions | object |
| Sca low value | boolean |
| International ID | text |
| Mastercard bin | text |
| Mcc | text |
| Sca mode | text |
| Tof | text |
| Visa bin | text |
| Links | object |
Templates
Look for onPay templates in the WEXTL template library.
Browse templates →Explore alternative apps
- bexio[2]Business software for small businesses and startups.
- BillduInvoice creation, billing, and payment management for small businesses.
- BlueSnapGlobal payment gateway for accepting cards, local payment methods, and managing subscriptions.
- CheckoutGlobal payment platform for accepting cards, wallets, and alternative payment methods.
- BillAccounts-payable and receivable — manage bills, invoices, vendors, and payments.
References
- WEXTL® onPay Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for onPay.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:12