Requirements
Checkout requires an active account and an API access token from your account settings to connect — both are set up on its own site.[3]
Get your Checkout credentials
- URLselectRequired
- Secret API KeytextRequired
Log in to the Checkout.com Dashboard → Developers → API Keys to view your Secret API Key.
[1]
Connect Checkout in WEXTL
- Log in to your WEXTL account, add the Checkout 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 Checkout 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 →
Checkout node modules
The list below is a reference of every Checkout node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every Checkout node module below — each one opens to show its input parameters, outputs, and connection requirements.
Watch DisputesTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Entity ID | text |
| Sub entity ID | text |
| Processing channel | text |
| Segment ID | text |
| Category | text |
| Status | text |
| Amount | number |
| Currency | text |
| Reason code | text |
| Payment ID | text |
| Payment action ID | text |
| Payment reference | text |
| Payment arn | text |
| Payment mcc | text |
| Payment method | text |
| Evidence required by | date |
| Received on | date |
| Last update | date |
| Resolved reason | text |
1other output field
Watch PaymentsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Requested on | date |
| Source | object |
| Type | text |
| Expiry month | text |
| Expiry year | text |
| Name | text |
| Scheme | text |
| Local schemes | array |
| Last 4 | text |
| Fingerprint | text |
| Bin | text |
| Card type | text |
| Amount | number |
| Amount requested | number |
| Currency | text |
| Payment type | text |
| Processing channel ID | text |
| Reference | text |
| Status | text |
| Balances | object |
| Total authorized | number |
| Total captured | number |
| Total refunded | number |
| 3ds | object |
| Eci | text |
| Version | text |
| Risk | object |
| Flagged | boolean |
| Score | text |
| Customer | object |
| text | |
| Name | text |
| Billing descriptor | object |
| Name | text |
| City | text |
| Metadata | object |
| Actions | array |
Watch TransactionsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Created on | date |
| Status | text |
| Transaction type | text |
| Client | object |
| ID | text |
| Entity | object |
| ID | text |
| Card | object |
| ID | text |
| Network | text |
| Digital card | object |
| ID | text |
| Wallet type | text |
| Cardholder | object |
| ID | text |
| Amounts | object |
| Total held | object |
| Total authorized | object |
| Total reversed | object |
| Total cleared | object |
| Total refunded | object |
| Merchant | object |
| ID | text |
| Name | text |
| City | text |
| State | text |
| Country code | text |
| Category code | text |
| Reference transaction | object |
| Transaction ID | text |
| Reference type | text |
| Messages | array |
| links | object |
| Self | object |
| Card | object |
| Cardholder | object |
| Reference transaction | object |
Get 3DS EnrollmentAction
Get a CardAction
Input fields[3]
| Field | Type |
|---|---|
Card IDRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Client ID | text |
| Entity ID | text |
| Cardholder ID | text |
| Card product ID | text |
| User ID | text |
| Last four | text |
| Expiry month | number |
| Expiry year | number |
| Status | text |
| Display name | text |
| Type | text |
| Billing currency | text |
| Issuing country | text |
| Reference | text |
| Metadata | object |
| Udf 1 | text |
| Udf 2 | text |
| Udf 3 | text |
| Udf 4 | text |
| Udf 5 | text |
| Revocation date | text |
| Root card ID | text |
| Parent card ID | text |
| Scheme | text |
4other output fields
Get a CardholderAction
Input fields[3]
| Field | Type |
|---|---|
Cardholder IDRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| First name | text |
| Middle name | text |
| Last name | text |
| text | |
| Phone number | object |
| Country code | text |
| Number | text |
| Date of birth | text |
| Billing address | object |
| Address line 1 | text |
| Address line 2 | text |
| City | text |
| State | text |
| Zip | text |
| Country | text |
| Residency address | object |
| Address line 1 | text |
| Address line 2 | text |
| City | text |
| State | text |
| Zip | text |
| Country | text |
| Reference | text |
| Client ID | text |
| Account entity ID | text |
| Parent sub entity ID | text |
| Entity ID | text |
| Status | text |
| Created date | date |
| Last modified date | date |
| links | object |
| Self | object |
| Cards | object |
Get a CustomerAction
Get a DisputeAction
Input fields[3]
| Field | Type |
|---|---|
Dispute IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Entity ID | text |
| Sub entity ID | text |
| Reference | text |
| Category | text |
| Amount | number |
| Currency | text |
| Reason code | text |
| Status | text |
| Resolved reason | text |
| Relevant evidence | array |
| Evidence required by | date |
| Received on | date |
| Last update | date |
| Is ce candidate | boolean |
| Payment | object |
| ID | text |
| Action ID | text |
| Processing channel ID | text |
| Amount | number |
| Currency | text |
| Reference | text |
| Method | text |
| Acquirer reference number | text |
| Mcc | text |
| 3ds | object |
| Evidence list | array |
| Evidence bundle | array |
| Segment ID | text |
| links | object |
| Self | object |
| Evidence | object |
Get a File's InfoAction
Get a PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Payment IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Requested on | date |
| Source | object |
| Type | text |
| ID | text |
| Billing address | object |
| Phone | object |
| Expiry month | number |
| Expiry year | number |
| Name | text |
| Scheme | text |
| Scheme local | text |
| Local schemes | array |
| Destination | object |
| Type | text |
| ID | text |
| Amount | number |
| Amount requested | number |
| Currency | text |
| Payment type | text |
| Payment plan | object |
| Amount variability | text |
| Days between payments | number |
| Total number of payments | number |
| Current payment number | number |
| Expiry | text |
| Reference | text |
| Description | text |
| Approved | boolean |
| Expires on | text |
| Status | text |
| Balances | object |
| Total authorized | number |
| Total voided | number |
| Available to void | number |
| Total captured | number |
| Available to capture | number |
| Total refunded | number |
| Available to refund | number |
| 3ds | object |
| Downgraded | boolean |
| Enrolled | text |
| Signature valid | text |
| Authentication response | text |
| Authentication status reason | text |
| Cryptogram | text |
| Xid | text |
| Eci | text |
| Version | text |
| Exemption | text |
| Authentication | object |
| Experience | text |
| Risk | object |
| Flagged | boolean |
| Score | number |
| Customer | object |
| ID | text |
| text | |
| Name | text |
| Summary | object |
| Billing descriptor | object |
| Name | text |
| City | text |
| Reference | text |
| Local descriptors | array |
15other output fields
Get a Payment LinkAction
Input fields[3]
| Field | Type |
|---|---|
Paylink Link IDRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Payment ID | text |
| Amount | number |
| Currency | text |
| Reference | text |
| Description | text |
| Created on | date |
| Expires on | date |
| Processing channel ID | text |
| Amount allocations | array |
| Customer | object |
| text | |
| Name | text |
| Shipping | object |
| Address | object |
| Billing | object |
| Address | object |
| Phone | object |
| Products | array |
| Metadata | object |
| Locale | text |
| Return URL | text |
| links | object |
| Self | object |
| Redirect | object |
Get a TransactionAction
Input fields[3]
| Field | Type |
|---|---|
Transaction IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Created on | date |
| Status | text |
| Transaction type | text |
| Client | object |
| ID | text |
| Entity | object |
| ID | text |
| Card | object |
| ID | text |
| Network | text |
| Digital card | object |
| ID | text |
| Wallet type | text |
| Cardholder | object |
| ID | text |
| Amounts | object |
| Total held | object |
| Total authorized | object |
| Total reversed | object |
| Total cleared | object |
| Total refunded | object |
| Merchant | object |
| ID | text |
| Name | text |
| City | text |
| State | text |
| Country code | text |
| Category code | text |
| Reference transaction | object |
| Transaction ID | text |
| Reference type | text |
| Messages | array |
| links | object |
| Self | object |
| Card | object |
| Cardholder | object |
| Reference transaction | object |
Get a TransferAction
Get an ApplicantAction
Get Dispute EvidenceAction
Input fields[3]
| Field | Type |
|---|---|
Dispute IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Proof of delivery or service file | text |
| Proof of delivery or service text | text |
| Proof of delivery or service date file | text |
| Proof of delivery or service date text | text |
| Invoice or receipt file | text |
| Invoice or receipt text | text |
| Invoice showing distinct transactions file | text |
| Invoice showing distinct transactions text | text |
| Customer communication file | text |
| Customer communication text | text |
| Refund or cancellation policy file | text |
| Refund or cancellation policy text | text |
| Recurring transaction agreement file | text |
| Recurring transaction agreement text | text |
| Additional evidence file | text |
| Additional evidence text | text |
| Arbitration no review files | array |
| Arbitration no review text | text |
| Arbitration review required files | array |
| Arbitration review required text | text |
1other output field
Get DisputesSearch
Input fields[3]
| Field | Type |
|---|---|
| From | date |
| To | date |
| ID | text |
| Entity IDs | text |
| Sub Entity IDs | text |
| Processing Channel IDs | text |
| Segment IDs | text |
| Statuses | text |
| Payment ID | text |
| Payment Reference | text |
| Payment ARN | text |
| Payment MCC | text |
| This Channel Only | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Entity ID | text |
| Sub entity ID | text |
| Processing channel | text |
| Segment ID | text |
| Category | text |
| Status | text |
| Amount | number |
| Currency | text |
| Reason code | text |
| Payment ID | text |
| Payment action ID | text |
| Payment reference | text |
| Payment arn | text |
| Payment mcc | text |
| Payment method | text |
| Evidence required by | date |
| Received on | date |
| Last update | date |
| Resolved reason | text |
1other output field
Get Entity BalancesSearch
Get Payment ActionsSearch
Get PaymentsSearch
Input fields[3]
| Field | Type |
|---|---|
| Query | text |
| From | date |
| To | date |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Requested on | date |
| Source | object |
| Type | text |
| Expiry month | text |
| Expiry year | text |
| Name | text |
| Scheme | text |
| Local schemes | array |
| Last 4 | text |
| Fingerprint | text |
| Bin | text |
| Card type | text |
| Amount | number |
| Amount requested | number |
| Currency | text |
| Payment type | text |
| Processing channel ID | text |
| Reference | text |
| Status | text |
| Balances | object |
| Total authorized | number |
| Total captured | number |
| Total refunded | number |
| 3ds | object |
| Eci | text |
| Version | text |
| Risk | object |
| Flagged | boolean |
| Score | text |
| Customer | object |
| text | |
| Name | text |
| Billing descriptor | object |
| Name | text |
| City | text |
| Metadata | object |
| Actions | array |
Get TransactionsSearch
Input fields[3]
| Field | Type |
|---|---|
| Cardholder ID | text |
| Card ID | text |
| Entity ID | text |
| Status | choice |
| From | date |
| To | date |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Created on | date |
| Status | text |
| Transaction type | text |
| Client | object |
| ID | text |
| Entity | object |
| ID | text |
| Card | object |
| ID | text |
| Network | text |
| Digital card | object |
| ID | text |
| Wallet type | text |
| Cardholder | object |
| ID | text |
| Amounts | object |
| Total held | object |
| Total authorized | object |
| Total reversed | object |
| Total cleared | object |
| Total refunded | object |
| Merchant | object |
| ID | text |
| Name | text |
| City | text |
| State | text |
| Country code | text |
| Category code | text |
| Reference transaction | object |
| Transaction ID | text |
| Reference type | text |
| Messages | array |
| links | object |
| Self | object |
| Card | object |
| Cardholder | object |
| Reference transaction | object |
Accept a DisputeAction
Input fields[3]
| Field | Type |
|---|---|
Dispute IDRequired | choice |
Activate a CardAction
Input fields[3]
| Field | Type |
|---|---|
Card IDRequired | text |
Anonymize an ApplicantAction
Capture a PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Payment IDRequired | choice |
| Amount | number |
| Capture Type | choice |
| Reference | text |
| Customer | object |
| Customer ID | text |
| Customer Email | |
| Customer Name | text |
| Tax Number | text |
| Customer Phone | object |
| Customer Summary | object |
| Description | text |
| Billing Descriptor | object |
Billing NameRequired | text |
CityRequired | text |
| Reference | text |
| Local Descriptors | array |
| Shipping | object |
| Address | object |
| Shipping Phone | object |
| From Address Zip | text |
| Tracking Information | array |
| Items | array |
| Amount Allocations | array |
| Processing | object |
| Order ID | text |
| OTP Value | text |
| Tax Amount | number |
| Surcharge Amount | number |
| Discount Amount | number |
| Duty Amount | number |
| Shipping Amount | number |
| Shipping Tax Amount | number |
| Purchase Country | text |
| Foreign Retailer Amount | number |
| Metadata | array |
| Key | text |
| Value | text |
Output fields[3]
| Field | Type |
|---|---|
| Action ID | text |
Create a CardAction
Input fields[3]
| Field | Type |
|---|---|
Cardholder IDRequired | text |
TypeRequired | choice |
Card Product IDRequired | text |
| Display Name | text |
| Is Single Use | boolean |
| Activate Card | boolean |
| Return Credentials | array |
| Control Profiles | array |
| Controls | array |
| Lifetime | object |
| Unit | text |
ValueRequired | number |
| Reference | text |
| Metadata | object |
| UDF1 | text |
| UDF2 | text |
| UDF3 | text |
| UDF4 | text |
| UDF5 | text |
| Revocation Date | date |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Client ID | text |
| Entity ID | text |
| Display name | text |
| Last four | text |
| Expiry month | number |
| Expiry year | number |
| Billing currency | text |
| Issuing country | text |
| Status | text |
| Type | text |
| Reference | text |
| Scheme | text |
| Created date | date |
| links | object |
| Self | object |
| Credentials | object |
| Revoke | object |
| Controls | object |
| Credentials | object |
| Number | text |
| Cvc 2 | text |
| Controls | array |
Create a CardholderAction
Input fields[3]
| Field | Type |
|---|---|
Entity IDRequired | text |
TypeRequired | choice |
First NameRequired | text |
Last NameRequired | text |
| Reference | text |
| Middle Name | text |
| Phone Number | object |
| Country Code | text |
| Number | text |
| Date of Birth | date |
Billing AddressRequired | object |
Address Line 1Required | text |
CityRequired | text |
ZIP CodeRequired | text |
CountryRequired | text |
| State | text |
| Address Line 2 | text |
| Residency Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| City | text |
| State | text |
| ZIP Code | text |
| Country | text |
| Document | object |
| Document Type | choice |
| Front Document ID | text |
| Back Document ID | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Client ID | text |
| Entity ID | text |
| Type | text |
| Status | text |
| Reference | text |
| Created date | text |
| Last modified date | text |
| links | object |
| Self | object |
| Cards | object |
Create a CustomerAction
Create a PaymentAction
Input fields[3]
| Field | Type |
|---|---|
| Payment Type | choice |
| Source | object |
| Type | text |
| Number | text |
| Expiry Month | number |
| Expiry Year | number |
| Name | text |
| CVV | text |
| Stored | boolean |
| Store For Future Use | boolean |
| Billing Address | object |
| Phone | object |
| Amount | number |
| Payment Type | text |
| Payment Plan | object |
| Amount Variability | text |
| Days Between Payments | number |
| Total Number of Payments | number |
| Current Payment Number | number |
| Expiry | date |
| Merchant Initiated | boolean |
| Reference | text |
| Description | text |
| Authorization Type | text |
| Partial Authorization | object |
| Enabled | boolean |
| Capture | boolean |
| Capture On | date |
| Expire On | date |
| Customer | object |
| Customer ID | text |
| Name | text |
| Tax Number | text |
| Phone | object |
| Summary | object |
| Billing Descriptor | object |
| Name | text |
| City | text |
| Reference | text |
| Local Descriptors | array |
| Shipping | object |
| First Name | text |
| Last Name | text |
| Address | object |
| Phone | object |
| From Address Zip | text |
| Timeframe | text |
| Method | text |
| Delay | number |
| 3DS | object |
| Enabled | boolean |
| Challenge Indicator | text |
| Authentication | object |
| Preferred Experiences | array |
| Processing Channel ID | text |
| Previous Payment ID | text |
15other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Reference | text |
| Customer | object |
| ID | text |
| text | |
| Name | text |
| Phone | object |
| Summary | object |
| 3ds | object |
| Downgraded | boolean |
| Enrolled | text |
| Upgrade reason | text |
| Subscription | object |
| ID | text |
| Processing | object |
| Continuation payload | text |
| Partner payment ID | text |
| Pan type processed | text |
| Cko network token available | boolean |
| links | object |
| Self | object |
| Redirect | object |
Create a Payment LinkAction
Input fields[3]
| Field | Type |
|---|---|
AmountRequired | number |
CurrencyRequired | text |
BillingRequired | object |
AddressRequired | object |
| Phone | object |
| Payment Type | choice |
| Billing Descriptor | object |
NameRequired | text |
CityRequired | text |
| Reference | text |
| Reference | text |
| Description | text |
| Display Name | text |
| Processing Channel ID | text |
| Amount Allocations | array |
| Expires In | number |
| Customer | object |
| Name | text |
| Phone | object |
| Summary | object |
| Shipping | object |
| Address | object |
| Phone | object |
| Recipient | object |
| Date of Birth | date |
| Account Number | text |
| Address | object |
| First Name | text |
| Last Name | text |
| Processing | object |
| AFT | boolean |
| Discount Amount | number |
| Shipping Amount | number |
| Tax Amount | number |
| Invoice ID | text |
| Brand Name | text |
| Locale | text |
| Partner Customer Risk Data | object |
| Custom Payment Method IDs | array |
| Airline Data | array |
| Allow Payment Methods | array |
| Allowed Payment Method | text |
| Disabled Payment Methods | array |
| Disabled Payment Method | text |
| Products | array |
| 3DS | object |
| Enabled | boolean |
| Attempt N3D | boolean |
| Challenge Indicator | choice |
| Allow Upgrade | boolean |
| Exemption | choice |
| Risk | object |
| Enabled | boolean |
9other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Expires on | date |
| Reference | text |
Create a TransferAction
Create an ApplicantAction
Delete a CustomerAction
Input fields[3]
| Field | Type |
|---|---|
Customer IDRequired | text |
Enroll a Card in 3DSAction
Input fields[3]
| Field | Type |
|---|---|
Card IDRequired | text |
Security PairRequired | object |
| Question | text |
| Answer | text |
Phone NumberRequired | object |
| Country Code | text |
| Number | text |
| Locale | text |
Increment AuthorizationAction
Input fields[3]
| Field | Type |
|---|---|
Payment IDRequired | choice |
| Amount | number |
| Reference | text |
| Metadata | object |
| Coupon Code | text |
| Partner ID | number |
Output fields[3]
| Field | Type |
|---|---|
| Action ID | text |
| Amount | number |
| Currency | text |
| Approved | boolean |
| Status | text |
| Auth code | text |
| Response code | text |
| Response summary | text |
| Expires on | text |
| Balances | object |
| Total authorized | number |
| Total voided | number |
| Available to void | number |
| Total captured | number |
| Available to capture | number |
| Total refunded | number |
| Available to refund | number |
| Processed on | date |
| Reference | text |
| Processing | object |
| Retrieval reference number | text |
| Acquirer transaction ID | text |
| Recommendation code | text |
| Surcharge amount | number |
| Eci | text |
| Scheme ID | text |
Make an API Calluniversal
Provide Dispute EvidenceAction
Input fields[3]
| Field | Type |
|---|---|
Dispute IDRequired | choice |
| Proof of Delivery or Service File | text |
| Proof of Delivery or Service Text | text |
| Proof of Delivery or Service Date File | text |
| Proof of Delivery or Service Date Text | text |
| Invoice or Receipt File | text |
| Invoice or Receipt Text | text |
| Invoice Showing Distinct Transactions File | text |
| Invoice Showing Distinct Transactions Text | text |
| Customer Communication File | text |
| Customer Communication Text | text |
| Refund or Cancellation Policy File | text |
| Refund or Cancellation Policy Text | text |
| Recurring Transaction Agreement File | text |
| Recurring Transaction Agreement Text | text |
| Additional Evidence File | text |
| Additional Evidence Text | text |
| Arbitration No Review Files | array |
| Arbitration No Review Text | text |
| Arbitration Review Required Files | array |
2other input fields
Refund a PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Payment IDRequired | choice |
AmountRequired | number |
ReferenceRequired | text |
| Amount Allocations | array |
| Capture Action ID | text |
| Items | array |
| Destination | object |
| Account Type | text |
Account NumberRequired | text |
Bank CodeRequired | text |
| Branch Code | text |
| IBAN | text |
| BBAN | text |
| SWIFT BIC | text |
CountryRequired | text |
Account HolderRequired | object |
| Bank | object |
| Metadata | array |
| Key | text |
| Value | text |
Output fields[3]
| Field | Type |
|---|---|
| Action ID | text |
Reverse a PaymentAction
Submit EvidenceAction
Update a CardholderAction
Input fields[3]
| Field | Type |
|---|---|
Cardholder IDRequired | text |
| First Name | text |
| Middle Name | text |
| Last Name | text |
| Date of Birth | date |
| Phone Number | object |
| Country Code | text |
| Number | text |
| Billing Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| City | text |
| State | text |
| Zip | text |
| Country | text |
| Residency Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| City | text |
| State | text |
| Zip | text |
| Country | text |
| Document | object |
| Type | text |
| Front Document ID | text |
| Back Document ID | text |
Output fields[3]
| Field | Type |
|---|---|
| Last modified date | text |
Update a CustomerAction
Input fields[3]
| Field | Type |
|---|---|
Customer IDRequired | text |
| Name | text |
| Phone | object |
| Country Code | text |
| Number | text |
| Metadata | array |
| Key | text |
| Value | text |
| Default | text |
Update an ApplicantAction
Update Card DetailsAction
Upload a FileAction
Templates
Look for Checkout templates in the WEXTL template library.
Browse templates →Explore alternative apps
- BlueSnap[2]Global payment gateway for accepting cards, local payment methods, and managing subscriptions.
- BilltrustB2B accounts receivable and payment automation platform for invoices, collections, and cash application.
- AdyenGlobal payment platform for online, in-person, and unified commerce transactions.
- BillogramDigital invoicing and billing platform that sends invoices and collects payments from customers.
- CapiumCloud accounting and practice management platform for accountants, covering invoicing, expenses, payments, and client communications.
References
- WEXTL® Checkout Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Checkout.
- WEXTL® visual workflow builder data.
Last updated: Jul 23, 2026 22:39