About this integration
Payment gateway for sessions, links, subscriptions, and settlements. Connect it to any workflow without writing code.
You can choose from 14 triggers, 23 search modules and 30 actions. The connection type is basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for ePay - Access Token.
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 |
|---|---|---|
ePay - Access TokenRequired | password | Your ePay API key, sent as a Bearer token. Create one in the ePay backoffice (or via the Create API Key endpoint) - keys starting with 'test_' are for the test environment and keys starting with 'live_' are for the live environment. Partners should instead generate a merchant access token (Request Merchant Access Token) and use it here in place of the API key. |
Use it in workflow automation
Start with Watch Billing Agreements, then add Abort Payment.
Triggers, searches and actions
Explore the fields available for each ePay Payments trigger, search, and action — 14 triggers, 23 searchs, and 30 actions.
Triggers
Whenever something changes in the app, one of 14 available triggers can start a run immediately.
- Watch Billing Agreements
- Watch Billing Charges
- Watch Billing Plans
- Watch Events
- Watch Imported Payment Methods
9more triggers
Searches
23 search modules let you query the app mid-run and feed the results to the next step.
- Get Billing Agreement
- Get Billing Charge
- Get Billing Plan
- Get Merchant Account
- Get Multi-Link
18more searches
Actions
Use 30 action modules to write data back into the app from anywhere in a run.
- Abort Payment
- Activate Merchant Account
- Cancel Payment Link
- Capture Payment
- Close Merchant Account
25more actions
Explore the fields available for each ePay Payments trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
Billing Agreement | object |
ID | text |
Billing Plan ID | text |
Subscription ID | text |
Session ID | text |
Customer ID | text |
Next Charge At | date |
Last Charge At | date |
Desired Date | number |
State | text |
State Changed At | date |
Output fields
| Field | Type |
|---|---|
Billing Agreement Charge | object |
ID | text |
State | text |
Transaction ID | text |
Billing Plan ID | text |
Billing Agreement ID | text |
Deadline At | date |
Next Attempt At | date |
Created At | date |
Output fields
| Field | Type |
|---|---|
Billing Plan | object |
ID | text |
Instant Capture | text |
Name | text |
Color | text |
Emoji | text |
Amount | number |
Currency | text |
Max Attempts | number |
Interval | object |
Created At | date |
Output fields
| Field | Type |
|---|---|
User ID | number |
Email address | |
Name | text |
Date created | date |
Output fields
| Field | Type |
|---|---|
Card | object |
PAN | text |
Expire Month | text |
Expire Year | text |
PAR | text |
Issuer | text |
Scheme | text |
Country | text |
Segment | text |
Funding | text |
Imported Payment Method | object |
ID | text |
Payment Method ID | text |
Reference | text |
Created At | date |
Payment Method | object |
ID | text |
Type | text |
Sub Type | text |
Customer ID | text |
Expiry | date |
Created At | date |
Display Text | text |
Output fields
| Field | Type |
|---|---|
Account | object |
ID | text |
Name | text |
Address Line One | text |
Address Line Two | text |
City | text |
Postal Code | text |
Country Code | text |
Phone | text |
Email | text |
Timezone | text |
Output fields
| Field | Type |
|---|---|
Multi Link | object |
ID | text |
Point Of Sale ID | text |
State | text |
Amount | number |
Currency | text |
Subscription | object |
SCA Mode | text |
Timeout | number |
Instant Capture | text |
Text On Statement | text |
URL | url |
QR URL | url |
Output fields
| Field | Type |
|---|---|
ID | text |
Reference Transaction Operation ID | text |
Amount | number |
State | text |
Transaction ID | text |
Type | text |
Error Code | text |
Created At | date |
Finalized At | date |
Output fields
| Field | Type |
|---|---|
Point Of Sale | object |
ID | text |
Name | text |
Descriptor | text |
Created At | date |
Updated At | date |
Hosted Configuration | object |
Instant Capture | text |
SCA Mode | text |
Timeout | number |
Notification URL | url |
Success URL | url |
Failure URL | url |
Retry URL | url |
Max Attempts | number |
Processor | array |
Exemptions | array |
Output fields
| Field | Type |
|---|---|
Settlement Transaction | object |
ID | text |
Settlement Transfer ID | text |
Transaction ID | text |
Agreement ID | text |
Merchant Reference | text |
Acquirer Reference | text |
Posting Date | date |
Settlement Net Amount | text |
Settlement Currency | text |
Adjustments | array |
Transaction | object |
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Output fields
| Field | Type |
|---|---|
Settlement Transfer | object |
ID | text |
Acquirer | text |
Settlement Name | text |
Settlement Ids | array |
Posting Date | date |
Net Amount | text |
Currency | text |
Acquirer Reference | text |
Adjustments | array |
Adjustment Sums | array |
Output fields
| Field | Type |
|---|---|
Subscription | object |
ID | text |
Payment Method ID | text |
Currency | text |
Customer ID | text |
Point Of Sale ID | text |
Reference | text |
Description | text |
State | text |
Status Reason | text |
Type | text |
Payment Method | object |
ID | text |
Type | text |
Sub Type | text |
Customer ID | text |
Expiry | date |
Created At | date |
Display Text | text |
Output fields
| Field | Type |
|---|---|
Terminal | object |
ID | text |
Point Of Sale ID | text |
Device ID | text |
External ID | text |
Created At | date |
Point Of Sale | object |
ID | text |
Name | text |
Descriptor | text |
Created At | date |
Updated At | date |
Device | object |
ID | text |
Description | text |
Created At | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Terminal | text |
Acquirer | text |
Network | text |
SCA | text |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Payment Method Sub Type | text |
Payment Method Expiry | date |
Payment Method Display Text | text |
Payment Method Holder Name | text |
SCA Mode | text |
Customer ID | text |
Amount | number |
Fee | number |
11other output fields
Searches
Input fields
| Field | Type |
|---|---|
Agreement IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Billing Agreement | object |
ID | text |
Billing Plan ID | text |
Subscription ID | text |
Session ID | text |
Customer ID | text |
Next Charge At | date |
Last Charge At | date |
Desired Date | number |
State | text |
State Changed At | date |
Input fields
| Field | Type |
|---|---|
Billing Agreement Charge IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Billing Agreement Charge | object |
ID | text |
State | text |
Transaction ID | text |
Billing Plan ID | text |
Billing Agreement ID | text |
Deadline At | date |
Next Attempt At | date |
Created At | date |
Input fields
| Field | Type |
|---|---|
Plan IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Billing Plan | object |
ID | text |
Instant Capture | text |
Name | text |
Color | text |
Emoji | text |
Amount | number |
Currency | text |
Max Attempts | number |
Interval | object |
Created At | date |
Input fields
| Field | Type |
|---|---|
Account IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Account | object |
ID | text |
Name | text |
Address Line One | text |
Address Line Two | text |
City | text |
Postal Code | text |
Country Code | text |
Phone | text |
Email | text |
Timezone | text |
Input fields
| Field | Type |
|---|---|
Multi Link IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Multi Link | object |
ID | text |
Point Of Sale ID | text |
State | text |
Amount | number |
Currency | text |
Subscription | object |
SCA Mode | text |
Timeout | number |
Instant Capture | text |
Text On Statement | text |
URL | url |
QR URL | url |
Input fields
| Field | Type |
|---|---|
Session IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Session | object |
ID | text |
Subscription ID | text |
Amount | number |
Attributes | object |
Exemptions | array |
Allowed Payment Methods | array |
Currency | text |
Expires At | date |
Instant Capture | text |
Max Attempts | number |
Transaction | object |
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Input fields
| Field | Type |
|---|---|
Point Of Sale IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Point Of Sale | object |
ID | text |
Name | text |
Descriptor | text |
Created At | date |
Updated At | date |
Hosted Configuration | object |
Instant Capture | text |
SCA Mode | text |
Timeout | number |
Notification URL | url |
Success URL | url |
Failure URL | url |
Retry URL | url |
Max Attempts | number |
Processor | array |
Exemptions | array |
Input fields
| Field | Type |
|---|---|
Transfer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Settlement Transfer | object |
ID | text |
Acquirer | text |
Settlement Name | text |
Settlement Ids | array |
Posting Date | date |
Net Amount | text |
Currency | text |
Acquirer Reference | text |
Adjustments | array |
Adjustment Sums | array |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Subscription | object |
ID | text |
Payment Method ID | text |
Currency | text |
Customer ID | text |
Point Of Sale ID | text |
Reference | text |
Description | text |
State | text |
Status Reason | text |
Type | text |
Payment Method | object |
ID | text |
Type | text |
Sub Type | text |
Customer ID | text |
Expiry | date |
Created At | date |
Display Text | text |
Input fields
| Field | Type |
|---|---|
Transaction IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Transaction | object |
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Aggregates | object |
Authorized | number |
Captured | number |
Refunded | number |
Voided | number |
Remaining | number |
Paid Out | number |
Acquirer Agreement | object |
Acquirer | text |
MCC | text |
Operations | array |
ID | text |
Reference Transaction Operation ID | text |
Amount | number |
State | text |
Transaction ID | text |
Type | text |
Error Code | text |
Created At | date |
Finalized At | date |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Billing Agreement | object |
ID | text |
Billing Plan ID | text |
Subscription ID | text |
Session ID | text |
Customer ID | text |
Next Charge At | date |
Last Charge At | date |
Desired Date | number |
State | text |
State Changed At | date |
Input fields
| Field | Type |
|---|---|
Billing Agreement ID | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Billing Agreement Charge | object |
ID | text |
State | text |
Transaction ID | text |
Billing Plan ID | text |
Billing Agreement ID | text |
Deadline At | date |
Next Attempt At | date |
Created At | date |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Billing Plan | object |
ID | text |
Instant Capture | text |
Name | text |
Color | text |
Emoji | text |
Amount | number |
Currency | text |
Max Attempts | number |
Interval | object |
Created At | date |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Card | object |
PAN | text |
Expire Month | text |
Expire Year | text |
PAR | text |
Issuer | text |
Scheme | text |
Country | text |
Segment | text |
Funding | text |
Imported Payment Method | object |
ID | text |
Payment Method ID | text |
Reference | text |
Created At | date |
Payment Method | object |
ID | text |
Type | text |
Sub Type | text |
Customer ID | text |
Expiry | date |
Created At | date |
Display Text | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Account | object |
ID | text |
Name | text |
Address Line One | text |
Address Line Two | text |
City | text |
Postal Code | text |
Country Code | text |
Phone | text |
Email | text |
Timezone | text |
Input fields
| Field | Type |
|---|---|
Point Of Sale ID | choice |
State | choice |
Created Before | date |
Created After | date |
Limit | number |
Output fields
| Field | Type |
|---|---|
Multi Link | object |
ID | text |
Point Of Sale ID | text |
State | text |
Amount | number |
Currency | text |
Subscription | object |
SCA Mode | text |
Timeout | number |
Instant Capture | text |
Text On Statement | text |
URL | url |
QR URL | url |
Input fields
| Field | Type |
|---|---|
Finalized Before | date |
Finalized After | date |
Point Of Sale ID | array |
Point Of Sale ID | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Reference Transaction Operation ID | text |
Amount | number |
State | text |
Transaction ID | text |
Type | text |
Error Code | text |
Created At | date |
Finalized At | date |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Point Of Sale | object |
ID | text |
Name | text |
Descriptor | text |
Created At | date |
Updated At | date |
Hosted Configuration | object |
Instant Capture | text |
SCA Mode | text |
Timeout | number |
Notification URL | url |
Success URL | url |
Failure URL | url |
Retry URL | url |
Max Attempts | number |
Processor | array |
Exemptions | array |
Input fields
| Field | Type |
|---|---|
Transfer IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Settlement Transaction | object |
ID | text |
Settlement Transfer ID | text |
Transaction ID | text |
Agreement ID | text |
Merchant Reference | text |
Acquirer Reference | text |
Posting Date | date |
Settlement Net Amount | text |
Settlement Currency | text |
Adjustments | array |
Transaction | object |
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Settlement Transfer | object |
ID | text |
Acquirer | text |
Settlement Name | text |
Settlement Ids | array |
Posting Date | date |
Net Amount | text |
Currency | text |
Acquirer Reference | text |
Adjustments | array |
Adjustment Sums | array |
Input fields
| Field | Type |
|---|---|
Created Before | date |
Created After | date |
Customer ID | choice |
Reference | text |
Currency | text |
State | choice |
Payment Method ID | choice |
Point Of Sale ID | choice |
Type | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Subscription | object |
ID | text |
Payment Method ID | text |
Currency | text |
Customer ID | text |
Point Of Sale ID | text |
Reference | text |
Description | text |
State | text |
Status Reason | text |
Type | text |
Payment Method | object |
ID | text |
Type | text |
Sub Type | text |
Customer ID | text |
Expiry | date |
Created At | date |
Display Text | text |
Input fields
| Field | Type |
|---|---|
Point Of Sale ID | choice |
Device ID | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Terminal | object |
ID | text |
Point Of Sale ID | text |
Device ID | text |
External ID | text |
Created At | date |
Point Of Sale | object |
ID | text |
Name | text |
Descriptor | text |
Created At | date |
Updated At | date |
Device | object |
ID | text |
Description | text |
Created At | date |
Input fields
| Field | Type |
|---|---|
Session ID | choice |
Terminal ID | choice |
Point Of Sale ID | choice |
Subscription ID | choice |
Billing Agreement Charge ID | choice |
Reference | text |
Reference Mode | choice |
Created Before | date |
Created After | date |
Customer ID | choice |
Currency | text |
State | choice |
Type | choice |
Error Code | text |
Payment Method Type | choice |
Payment Method Sub Type | choice |
Amount Mode | choice |
Amount | number |
3other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Terminal | text |
Acquirer | text |
Network | text |
SCA | text |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Payment Method Sub Type | text |
Payment Method Expiry | date |
Payment Method Display Text | text |
Payment Method Holder Name | text |
SCA Mode | text |
Customer ID | text |
Amount | number |
Fee | number |
11other output fields
Actions
Input fields
| Field | Type |
|---|---|
Transaction IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Account IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Payment Link IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Transaction IDRequired | choice |
AmountRequired | number |
Void Remaining | boolean |
Output fields
| Field | Type |
|---|---|
Operation ID | text |
Success | boolean |
State | text |
Error Code | object |
Code | text |
Message | text |
Input fields
| Field | Type |
|---|---|
Account IDRequired | choice |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Output fields
| Field | Type |
|---|---|
Name | text |
Key | text |
Input fields
| Field | Type |
|---|---|
Billing Plan IDRequired | choice |
Subscription IDRequired | choice |
Reference | text |
Next Charge At | date |
Output fields
| Field | Type |
|---|---|
Billing Agreement | object |
ID | text |
Billing Plan ID | text |
Subscription ID | text |
Session ID | text |
Customer ID | text |
Next Charge At | date |
Last Charge At | date |
Desired Date | number |
State | text |
State Changed At | date |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
AmountRequired | number |
CurrencyRequired | text |
Instant Capture | choice |
Max AttemptsRequired | number |
Interval | object |
PeriodRequired | choice |
FrequencyRequired | number |
Output fields
| Field | Type |
|---|---|
Billing Plan | object |
ID | text |
Instant Capture | text |
Name | text |
Color | text |
Emoji | text |
Amount | number |
Currency | text |
Max Attempts | number |
Interval | object |
Created At | date |
Input fields
| Field | Type |
|---|---|
Account IDRequired | choice |
EnvironmentRequired | choice |
Output fields
| Field | Type |
|---|---|
Expires At | date |
Access Token | text |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
EmailRequired | |
Currency CodeRequired | text |
Language | text |
TimezoneRequired | text |
DomainRequired | text |
Output fields
| Field | Type |
|---|---|
Account | object |
ID | text |
Name | text |
Address Line One | text |
Address Line Two | text |
City | text |
Postal Code | text |
Country Code | text |
Phone | text |
Email | text |
Timezone | text |
Input fields
| Field | Type |
|---|---|
Point Of Sale IDRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
Subscription | object |
Amount | number |
TypeRequired | choice |
Expiry Date | date |
Interval | object |
Billing Agreement | object |
SCA Mode | choice |
Timeout | number |
Instant Capture | choice |
Text On Statement | text |
Attributes | object |
Report Failure | boolean |
Report Expired | boolean |
Dynamic Amount | boolean |
Notification URL | url |
Pre-Auth URL | url |
Success URL | url |
Return URL | url |
Failure URL | url |
Retry URL | url |
5other input fields
Output fields
| Field | Type |
|---|---|
Multi Link | object |
ID | text |
Point Of Sale ID | text |
State | text |
Amount | number |
Currency | text |
Subscription | object |
SCA Mode | text |
Timeout | number |
Instant Capture | text |
Text On Statement | text |
URL | url |
QR URL | url |
Input fields
| Field | Type |
|---|---|
Point Of Sale IDRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
Transaction Type | choice |
Reference | text |
Instant Capture | choice |
SCA Mode | choice |
Timeout | number |
Exemptions | array |
Exemption | choice |
Allowed Payment Methods | array |
Payment Method | text |
Max Attempts | number |
Generate QR Code | boolean |
Report Failure | boolean |
Report Expired | boolean |
Dynamic Amount | boolean |
Text On Statement | text |
Customer ID | text |
Attributes | object |
11other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Session ID | text |
URL | url |
QR Code | text |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
DomainRequired | text |
Webhook AuthenticationRequired | text |
Output fields
| Field | Type |
|---|---|
Point Of Sale | object |
ID | text |
Name | text |
Descriptor | text |
Created At | date |
Updated At | date |
Hosted Configuration | object |
Instant Capture | text |
SCA Mode | text |
Timeout | number |
Notification URL | url |
Success URL | url |
Failure URL | url |
Retry URL | url |
Max Attempts | number |
Processor | array |
Exemptions | array |
Input fields
| Field | Type |
|---|---|
Multi Link IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Payment Method IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Point Of Sale IDRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
Transaction Type | choice |
Reference | text |
Instant Capture | choice |
SCA Mode | choice |
Timeout | number |
Exemptions | array |
Exemption | choice |
Allowed Payment Methods | array |
Payment Method | text |
Max Attempts | number |
Generate QR Code | boolean |
Report Failure | boolean |
Report Expired | boolean |
Dynamic Amount | boolean |
Text On Statement | text |
Customer ID | text |
Attributes | object |
11other input fields
Output fields
| Field | Type |
|---|---|
QR Code | text |
Payment Window URL | url |
Javascript | url |
Key | text |
Session | object |
ID | text |
Subscription ID | text |
Amount | number |
Attributes | object |
Exemptions | array |
Allowed Payment Methods | array |
Currency | text |
Expires At | date |
Instant Capture | text |
Max Attempts | number |
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 |
Status code | number |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
AmountRequired | number |
Currency | text |
Reference | text |
Instant Capture | choice |
Text On Statement | text |
Notification URLRequired | url |
Attributes | object |
Output fields
| Field | Type |
|---|---|
Transaction | object |
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Input fields
| Field | Type |
|---|---|
TransactionsRequired | array |
Subscription IDRequired | choice |
AmountRequired | number |
Currency | text |
Reference | text |
Instant Capture | choice |
Text On Statement | text |
Notification URLRequired | url |
Attributes | object |
Output fields
| Field | Type |
|---|---|
Transactions | array |
Reference | text |
Transaction | object |
Error | object |
Input fields
| Field | Type |
|---|---|
TransactionRequired | object |
Point Of Sale IDRequired | choice |
Reference | text |
AmountRequired | number |
CurrencyRequired | text |
Instant Capture | choice |
Processor | array |
Text On Statement | text |
Attributes | object |
Customer ID | text |
Customer | object |
Payment MethodRequired | object |
Card | object |
Output fields
| Field | Type |
|---|---|
Transaction | object |
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Aggregates | object |
Authorized | number |
Captured | number |
Refunded | number |
Voided | number |
Remaining | number |
Paid Out | number |
Operations | array |
ID | text |
Reference Transaction Operation ID | text |
Amount | number |
State | text |
Transaction ID | text |
Type | text |
Error Code | text |
Created At | date |
Finalized At | date |
Acquirer Agreement | object |
Acquirer | text |
MCC | text |
Session | object |
ID | text |
Subscription ID | text |
Amount | number |
Attributes | object |
Exemptions | array |
Allowed Payment Methods | array |
Currency | text |
Expires At | date |
Instant Capture | text |
Max Attempts | number |
Subscription | object |
ID | text |
Payment Method ID | text |
Currency | text |
Customer ID | text |
Point Of Sale ID | text |
Reference | text |
Description | text |
State | text |
Status Reason | text |
Type | text |
SCA | object |
Rejected | boolean |
Type | text |
Verification | text |
Card | object |
PAN | text |
Expire Month | text |
Expire Year | text |
PAR | text |
Issuer | text |
Scheme | text |
Country | text |
Segment | text |
Funding | text |
Input fields
| Field | Type |
|---|---|
Point Of Sale IDRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
Payment Method IDRequired | choice |
Reference | text |
Text On Statement | text |
Processor | array |
Processor | choice |
Attributes | object |
Customer | object |
First NameRequired | text |
Last NameRequired | text |
IPRequired | text |
Birthdate | text |
Notification URLRequired | url |
Output fields
| Field | Type |
|---|---|
Transaction | object |
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Input fields
| Field | Type |
|---|---|
Point Of Sale IDRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
Payment Method IDRequired | choice |
Reference | text |
Text On Statement | text |
Processor | array |
Processor | choice |
Attributes | object |
Customer | object |
First NameRequired | text |
Last NameRequired | text |
IPRequired | text |
Birthdate | text |
Output fields
| Field | Type |
|---|---|
Transaction | object |
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Aggregates | object |
Authorized | number |
Captured | number |
Refunded | number |
Voided | number |
Remaining | number |
Paid Out | number |
Operations | array |
ID | text |
Reference Transaction Operation ID | text |
Amount | number |
State | text |
Transaction ID | text |
Type | text |
Error Code | text |
Created At | date |
Finalized At | date |
Acquirer Agreement | object |
Acquirer | text |
MCC | text |
Session | object |
ID | text |
Subscription ID | text |
Amount | number |
Attributes | object |
Exemptions | array |
Allowed Payment Methods | array |
Currency | text |
Expires At | date |
Instant Capture | text |
Max Attempts | number |
Subscription | object |
ID | text |
Payment Method ID | text |
Currency | text |
Customer ID | text |
Point Of Sale ID | text |
Reference | text |
Description | text |
State | text |
Status Reason | text |
Type | text |
SCA | object |
Rejected | boolean |
Type | text |
Verification | text |
Card | object |
PAN | text |
Expire Month | text |
Expire Year | text |
PAR | text |
Issuer | text |
Scheme | text |
Country | text |
Segment | text |
Funding | text |
Input fields
| Field | Type |
|---|---|
Terminal | object |
Terminal ID | choice |
Suppress App Notifications | boolean |
Switch Back Timeout | number |
Activity To Resume | text |
Surcharge | boolean |
DCC | boolean |
TransactionRequired | object |
Point Of Sale IDRequired | choice |
Type | choice |
AmountRequired | number |
CurrencyRequired | text |
Notification URLRequired | url |
Reference | text |
Attributes | object |
Customer ID | text |
Customer | object |
Output fields
| Field | Type |
|---|---|
Transaction | object |
ID | text |
Subscription ID | text |
Billing Agreement Charge ID | text |
State | text |
Error Code | text |
External Status Codes | object |
Created At | date |
Session ID | text |
Payment Method ID | text |
Payment Method Type | text |
Input fields
| Field | Type |
|---|---|
Transaction IDRequired | choice |
AmountRequired | number |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Operations | array |
Operation ID | text |
Success | boolean |
State | text |
Error Code | object |
Input fields
| Field | Type |
|---|---|
Transaction IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Operation ID | text |
Success | boolean |
State | text |
Error Code | object |
Code | text |
Message | text |
Input fields
| Field | Type |
|---|---|
Agreement IDRequired | choice |
Next Charge AtRequired | date |
Output fields
| Field | Type |
|---|---|
Billing Agreement | object |
ID | text |
Billing Plan ID | text |
Subscription ID | text |
Session ID | text |
Customer ID | text |
Next Charge At | date |
Last Charge At | date |
Desired Date | number |
State | text |
State Changed At | date |
Input fields
| Field | Type |
|---|---|
Agreement IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Billing Agreement | object |
ID | text |
Billing Plan ID | text |
Subscription ID | text |
Session ID | text |
Customer ID | text |
Next Charge At | date |
Last Charge At | date |
Desired Date | number |
State | text |
State Changed At | date |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
AmountRequired | number |
TypeRequired | choice |
Expiry DateRequired | date |
Interval | object |
PeriodRequired | choice |
FrequencyRequired | number |
Output fields
| Field | Type |
|---|---|
Subscription | object |
ID | text |
Payment Method ID | text |
Currency | text |
Customer ID | text |
Point Of Sale ID | text |
Reference | text |
Description | text |
State | text |
Status Reason | text |
Type | text |
Payment Method | object |
ID | text |
Type | text |
Sub Type | text |
Customer ID | text |
Expiry | date |
Created At | date |
Display Text | text |
Input fields
| Field | Type |
|---|---|
Transaction IDRequired | choice |
AmountRequired | number |
Output fields
| Field | Type |
|---|---|
Operation ID | text |
Success | boolean |
State | text |
Error Code | object |
Code | text |
Message | text |