Skip to docs navigation

Checkout integration guide

Verified

How to connect Checkout to WEXTL and use its 3 triggers and 42 actions in your workflows. About Checkout: Global payment platform for accepting cards, wallets, and alternative payment methods.

  • 3 triggers
  • 17 searches
  • 25 actions
  • Polling
  • Auth: API key

AI-assisted documentation23 min read

This documentation is compiled from our integration source code, internal specs for Checkout, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Checkout on WEXTL →
  • Checkout
  • WEXTL
  • BlueSnap
  • Comanage
  • Billtrust
  • dLocal
  • Adyen
  • Billogram
  • Capium
  • Billdu
  • 1C:Enterprise (OData)
  • Coinbase
  • ApproveIt
  • Billingo
  • Elorus
  • Distru
  • Debitura
  • Dooer
  • Bybit
  • CoinGecko
  • Credit Repair Cloud
  • Daftra
  • ePay Payments
  • Commas
  • Donorbox
  • Chargebee
  • bexio
  • Corpay
  • Candis
  • Bill
  • Bling
  • URLselectRequired
  • Secret API KeytextRequired

    Log in to the Checkout.com Dashboard → Developers → API Keys to view your Secret API Key.[1]

  1. Log in to your WEXTL account, add the Checkout node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Checkout account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Connecting Checkout to WEXTL®
Video slide demonstrates how to integrate Checkout in the WEXTL visual workflow builder.[4]

Watch Disputes

Trigger
Output fields[3]
FieldType
IDtext
Entity IDtext
Sub entity IDtext
Processing channeltext
Segment IDtext
Categorytext
Statustext
Amountnumber
Currencytext
Reason codetext
Payment IDtext
Payment action IDtext
Payment referencetext
Payment arntext
Payment mcctext
Payment methodtext
Evidence required bydate
Received ondate
Last updatedate
Resolved reasontext

1other output field

Watch Payments

Trigger
Output fields[3]
FieldType
IDtext
Requested ondate
Sourceobject
Typetext
Expiry monthtext
Expiry yeartext
Nametext
Schemetext
Local schemesarray
Last 4text
Fingerprinttext
Bintext
Card typetext
Amountnumber
Amount requestednumber
Currencytext
Payment typetext
Processing channel IDtext
Referencetext
Statustext
Balancesobject
Total authorizednumber
Total capturednumber
Total refundednumber
3dsobject
Ecitext
Versiontext
Riskobject
Flaggedboolean
Scoretext
Customerobject
Emailtext
Nametext
Billing descriptorobject
Nametext
Citytext
Metadataobject
Actionsarray

Watch Transactions

Trigger
Output fields[3]
FieldType
IDtext
Created ondate
Statustext
Transaction typetext
Clientobject
IDtext
Entityobject
IDtext
Cardobject
IDtext
Networktext
Digital cardobject
IDtext
Wallet typetext
Cardholderobject
IDtext
Amountsobject
Total heldobject
Total authorizedobject
Total reversedobject
Total clearedobject
Total refundedobject
Merchantobject
IDtext
Nametext
Citytext
Statetext
Country codetext
Category codetext
Reference transactionobject
Transaction IDtext
Reference typetext
Messagesarray
linksobject
Selfobject
Cardobject
Cardholderobject
Reference transactionobject

Get 3DS Enrollment

Action
Input fields[3]
FieldType
Card IDRequired
text
Output fields[3]
FieldType
Localetext
Phone numberobject
Country codetext
Numbertext
Security questionobject
Questiontext
Answertext
Passwordtext
Created datetext
Last modified datetext

Get a Card

Action
Input fields[3]
FieldType
Card IDRequired
text
Output fields[3]
FieldType
IDtext
Client IDtext
Entity IDtext
Cardholder IDtext
Card product IDtext
User IDtext
Last fourtext
Expiry monthnumber
Expiry yearnumber
Statustext
Display nametext
Typetext
Billing currencytext
Issuing countrytext
Referencetext
Metadataobject
Udf 1text
Udf 2text
Udf 3text
Udf 4text
Udf 5text
Revocation datetext
Root card IDtext
Parent card IDtext
Schemetext

4other output fields

Get a Cardholder

Action
Input fields[3]
FieldType
Cardholder IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
First nametext
Middle nametext
Last nametext
Emailtext
Phone numberobject
Country codetext
Numbertext
Date of birthtext
Billing addressobject
Address line 1text
Address line 2text
Citytext
Statetext
Ziptext
Countrytext
Residency addressobject
Address line 1text
Address line 2text
Citytext
Statetext
Ziptext
Countrytext
Referencetext
Client IDtext
Account entity IDtext
Parent sub entity IDtext
Entity IDtext
Statustext
Created datedate
Last modified datedate
linksobject
Selfobject
Cardsobject

Get a Customer

Action
Input fields[3]
FieldType
Customer IDRequired
text
Output fields[3]
FieldType
IDtext
Emailtext
Defaulttext
Nametext
Phoneobject
Country codetext
Numbertext
Metadataobject
Coupon codetext
Partner IDnumber
Instrumentsarray

Get a Dispute

Action
Input fields[3]
FieldType
Dispute IDRequired
choice
Output fields[3]
FieldType
IDtext
Entity IDtext
Sub entity IDtext
Referencetext
Categorytext
Amountnumber
Currencytext
Reason codetext
Statustext
Resolved reasontext
Relevant evidencearray
Evidence required bydate
Received ondate
Last updatedate
Is ce candidateboolean
Paymentobject
IDtext
Action IDtext
Processing channel IDtext
Amountnumber
Currencytext
Referencetext
Methodtext
Acquirer reference numbertext
Mcctext
3dsobject
Evidence listarray
Evidence bundlearray
Segment IDtext
linksobject
Selfobject
Evidenceobject

Get a File's Info

Action
Input fields[3]
FieldType
File IDRequired
text
Output fields[3]
FieldType
IDtext
Filenametext
Purposetext
Sizenumber
Uploaded ondate

Get a Payment

Action
Input fields[3]
FieldType
Payment IDRequired
choice
Output fields[3]
FieldType
IDtext
Requested ondate
Sourceobject
Typetext
IDtext
Billing addressobject
Phoneobject
Expiry monthnumber
Expiry yearnumber
Nametext
Schemetext
Scheme localtext
Local schemesarray
Destinationobject
Typetext
IDtext
Amountnumber
Amount requestednumber
Currencytext
Payment typetext
Payment planobject
Amount variabilitytext
Days between paymentsnumber
Total number of paymentsnumber
Current payment numbernumber
Expirytext
Referencetext
Descriptiontext
Approvedboolean
Expires ontext
Statustext
Balancesobject
Total authorizednumber
Total voidednumber
Available to voidnumber
Total capturednumber
Available to capturenumber
Total refundednumber
Available to refundnumber
3dsobject
Downgradedboolean
Enrolledtext
Signature validtext
Authentication responsetext
Authentication status reasontext
Cryptogramtext
Xidtext
Ecitext
Versiontext
Exemptiontext
Authenticationobject
Experiencetext
Riskobject
Flaggedboolean
Scorenumber
Customerobject
IDtext
Emailtext
Nametext
Summaryobject
Billing descriptorobject
Nametext
Citytext
Referencetext
Local descriptorsarray

15other output fields

Get a Payment Link

Action
Input fields[3]
FieldType
Paylink Link IDRequired
text
Output fields[3]
FieldType
IDtext
Statustext
Payment IDtext
Amountnumber
Currencytext
Referencetext
Descriptiontext
Created ondate
Expires ondate
Processing channel IDtext
Amount allocationsarray
Customerobject
Emailtext
Nametext
Shippingobject
Addressobject
Billingobject
Addressobject
Phoneobject
Productsarray
Metadataobject
Localetext
Return URLtext
linksobject
Selfobject
Redirectobject

Get a Transaction

Action
Input fields[3]
FieldType
Transaction IDRequired
choice
Output fields[3]
FieldType
IDtext
Created ondate
Statustext
Transaction typetext
Clientobject
IDtext
Entityobject
IDtext
Cardobject
IDtext
Networktext
Digital cardobject
IDtext
Wallet typetext
Cardholderobject
IDtext
Amountsobject
Total heldobject
Total authorizedobject
Total reversedobject
Total clearedobject
Total refundedobject
Merchantobject
IDtext
Nametext
Citytext
Statetext
Country codetext
Category codetext
Reference transactionobject
Transaction IDtext
Reference typetext
Messagesarray
linksobject
Selfobject
Cardobject
Cardholderobject
Reference transactionobject

Get a Transfer

Action
Input fields[3]
FieldType
Transfer IDRequired
text
Output fields[3]
FieldType
IDtext
Referencetext
Statustext
Transfer typetext
Requested ondate
Reason codesarray
Sourceobject
Entity IDtext
Amountnumber
Currencytext
Destinationobject
Entity IDtext

Get an Applicant

Action
Input fields[3]
FieldType
Applicant IDRequired
text
Output fields[3]
FieldType
IDtext
Created ontext
Modified ontext
External applicant IDtext
Emailtext
External applicant nametext

Get Dispute Evidence

Action
Input fields[3]
FieldType
Dispute IDRequired
choice
Output fields[3]
FieldType
Proof of delivery or service filetext
Proof of delivery or service texttext
Proof of delivery or service date filetext
Proof of delivery or service date texttext
Invoice or receipt filetext
Invoice or receipt texttext
Invoice showing distinct transactions filetext
Invoice showing distinct transactions texttext
Customer communication filetext
Customer communication texttext
Refund or cancellation policy filetext
Refund or cancellation policy texttext
Recurring transaction agreement filetext
Recurring transaction agreement texttext
Additional evidence filetext
Additional evidence texttext
Arbitration no review filesarray
Arbitration no review texttext
Arbitration review required filesarray
Arbitration review required texttext

1other output field

Get Disputes

Search
Input fields[3]
FieldType
Fromdate
Todate
IDtext
Entity IDstext
Sub Entity IDstext
Processing Channel IDstext
Segment IDstext
Statusestext
Payment IDtext
Payment Referencetext
Payment ARNtext
Payment MCCtext
This Channel Onlyboolean
Limitnumber
Output fields[3]
FieldType
IDtext
Entity IDtext
Sub entity IDtext
Processing channeltext
Segment IDtext
Categorytext
Statustext
Amountnumber
Currencytext
Reason codetext
Payment IDtext
Payment action IDtext
Payment referencetext
Payment arntext
Payment mcctext
Payment methodtext
Evidence required bydate
Received ondate
Last updatedate
Resolved reasontext

1other output field

Get Entity Balances

Search
Input fields[3]
FieldType
Entity IDtext
Querytext
With Currency Account IDboolean
Limitnumber
Output fields[3]
FieldType
Descriptortext
Holding currencytext
Balancesobject
Pendingnumber
Availablenumber
Payablenumber
Collateralnumber
Operationalnumber

Get Payment Actions

Search
Input fields[3]
FieldType
Payment IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Typetext
Processed ondate
Amountnumber
Approvedboolean
Response codetext
Response summarytext

Get Payments

Search
Input fields[3]
FieldType
Querytext
Fromdate
Todate
Limitnumber
Output fields[3]
FieldType
IDtext
Requested ondate
Sourceobject
Typetext
Expiry monthtext
Expiry yeartext
Nametext
Schemetext
Local schemesarray
Last 4text
Fingerprinttext
Bintext
Card typetext
Amountnumber
Amount requestednumber
Currencytext
Payment typetext
Processing channel IDtext
Referencetext
Statustext
Balancesobject
Total authorizednumber
Total capturednumber
Total refundednumber
3dsobject
Ecitext
Versiontext
Riskobject
Flaggedboolean
Scoretext
Customerobject
Emailtext
Nametext
Billing descriptorobject
Nametext
Citytext
Metadataobject
Actionsarray

Get Transactions

Search
Input fields[3]
FieldType
Cardholder IDtext
Card IDtext
Entity IDtext
Statuschoice
Fromdate
Todate
Limitnumber
Output fields[3]
FieldType
IDtext
Created ondate
Statustext
Transaction typetext
Clientobject
IDtext
Entityobject
IDtext
Cardobject
IDtext
Networktext
Digital cardobject
IDtext
Wallet typetext
Cardholderobject
IDtext
Amountsobject
Total heldobject
Total authorizedobject
Total reversedobject
Total clearedobject
Total refundedobject
Merchantobject
IDtext
Nametext
Citytext
Statetext
Country codetext
Category codetext
Reference transactionobject
Transaction IDtext
Reference typetext
Messagesarray
linksobject
Selfobject
Cardobject
Cardholderobject
Reference transactionobject

Accept a Dispute

Action
Input fields[3]
FieldType
Dispute IDRequired
choice

Activate a Card

Action
Input fields[3]
FieldType
Card IDRequired
text

Anonymize an Applicant

Action
Input fields[3]
FieldType
Applicant IDRequired
text
Output fields[3]
FieldType
IDtext
Created ondate
Modified ondate
External applicant IDtext

Capture a Payment

Action
Input fields[3]
FieldType
Payment IDRequired
choice
Amountnumber
Capture Typechoice
Referencetext
Customerobject
Customer IDtext
Customer Emailemail
Customer Nametext
Tax Numbertext
Customer Phoneobject
Customer Summaryobject
Descriptiontext
Billing Descriptorobject
Billing NameRequired
text
CityRequired
text
Referencetext
Local Descriptorsarray
Shippingobject
Addressobject
Shipping Phoneobject
From Address Ziptext
Tracking Informationarray
Itemsarray
Amount Allocationsarray
Processingobject
Order IDtext
OTP Valuetext
Tax Amountnumber
Surcharge Amountnumber
Discount Amountnumber
Duty Amountnumber
Shipping Amountnumber
Shipping Tax Amountnumber
Purchase Countrytext
Foreign Retailer Amountnumber
Metadataarray
Keytext
Valuetext
Output fields[3]
FieldType
Action IDtext

Create a Card

Action
Input fields[3]
FieldType
Cardholder IDRequired
text
TypeRequired
choice
Card Product IDRequired
text
Display Nametext
Is Single Useboolean
Activate Cardboolean
Return Credentialsarray
Control Profilesarray
Controlsarray
Lifetimeobject
Unittext
ValueRequired
number
Referencetext
Metadataobject
UDF1text
UDF2text
UDF3text
UDF4text
UDF5text
Revocation Datedate
Output fields[3]
FieldType
IDtext
Client IDtext
Entity IDtext
Display nametext
Last fourtext
Expiry monthnumber
Expiry yearnumber
Billing currencytext
Issuing countrytext
Statustext
Typetext
Referencetext
Schemetext
Created datedate
linksobject
Selfobject
Credentialsobject
Revokeobject
Controlsobject
Credentialsobject
Numbertext
Cvc 2text
Controlsarray

Create a Cardholder

Action
Input fields[3]
FieldType
Entity IDRequired
text
TypeRequired
choice
First NameRequired
text
Last NameRequired
text
Referencetext
Middle Nametext
Emailemail
Phone Numberobject
Country Codetext
Numbertext
Date of Birthdate
Billing AddressRequired
object
Address Line 1Required
text
CityRequired
text
ZIP CodeRequired
text
CountryRequired
text
Statetext
Address Line 2text
Residency Addressobject
Address Line 1text
Address Line 2text
Citytext
Statetext
ZIP Codetext
Countrytext
Documentobject
Document Typechoice
Front Document IDtext
Back Document IDtext
Output fields[3]
FieldType
IDtext
Client IDtext
Entity IDtext
Typetext
Statustext
Referencetext
Created datetext
Last modified datetext
linksobject
Selfobject
Cardsobject

Create a Customer

Action
Input fields[3]
FieldType
EmailRequired
email
Nametext
Phoneobject
Country Codetext
Numbertext
Metadataarray
Keytext
Valuetext
Defaulttext
Output fields[3]
FieldType
IDtext

Create a Payment

Action
Input fields[3]
FieldType
Payment Typechoice
Sourceobject
Typetext
Numbertext
Expiry Monthnumber
Expiry Yearnumber
Nametext
CVVtext
Storedboolean
Store For Future Useboolean
Billing Addressobject
Phoneobject
Amountnumber
Payment Typetext
Payment Planobject
Amount Variabilitytext
Days Between Paymentsnumber
Total Number of Paymentsnumber
Current Payment Numbernumber
Expirydate
Merchant Initiatedboolean
Referencetext
Descriptiontext
Authorization Typetext
Partial Authorizationobject
Enabledboolean
Captureboolean
Capture Ondate
Expire Ondate
Customerobject
Customer IDtext
Emailemail
Nametext
Tax Numbertext
Phoneobject
Summaryobject
Billing Descriptorobject
Nametext
Citytext
Referencetext
Local Descriptorsarray
Shippingobject
First Nametext
Last Nametext
Emailemail
Addressobject
Phoneobject
From Address Ziptext
Timeframetext
Methodtext
Delaynumber
3DSobject
Enabledboolean
Challenge Indicatortext
Authenticationobject
Preferred Experiencesarray
Processing Channel IDtext
Previous Payment IDtext

15other input fields

Output fields[3]
FieldType
IDtext
Statustext
Referencetext
Customerobject
IDtext
Emailtext
Nametext
Phoneobject
Summaryobject
3dsobject
Downgradedboolean
Enrolledtext
Upgrade reasontext
Subscriptionobject
IDtext
Processingobject
Continuation payloadtext
Partner payment IDtext
Pan type processedtext
Cko network token availableboolean
linksobject
Selfobject
Redirectobject

Create a Payment Link

Action
Input fields[3]
FieldType
AmountRequired
number
CurrencyRequired
text
BillingRequired
object
AddressRequired
object
Phoneobject
Payment Typechoice
Billing Descriptorobject
NameRequired
text
CityRequired
text
Referencetext
Referencetext
Descriptiontext
Display Nametext
Processing Channel IDtext
Amount Allocationsarray
Expires Innumber
Customerobject
Emailemail
Nametext
Phoneobject
Summaryobject
Shippingobject
Addressobject
Phoneobject
Recipientobject
Date of Birthdate
Account Numbertext
Addressobject
First Nametext
Last Nametext
Processingobject
AFTboolean
Discount Amountnumber
Shipping Amountnumber
Tax Amountnumber
Invoice IDtext
Brand Nametext
Localetext
Partner Customer Risk Dataobject
Custom Payment Method IDsarray
Airline Dataarray
Allow Payment Methodsarray
Allowed Payment Methodtext
Disabled Payment Methodsarray
Disabled Payment Methodtext
Productsarray
3DSobject
Enabledboolean
Attempt N3Dboolean
Challenge Indicatorchoice
Allow Upgradeboolean
Exemptionchoice
Riskobject
Enabledboolean

9other input fields

Output fields[3]
FieldType
IDtext
Expires ondate
Referencetext

Create a Transfer

Action
Input fields[3]
FieldType
Transfer TypeRequired
choice
SourceRequired
object
Source IDtext
Amountnumber
Currencytext
DestinationRequired
object
Destination IDRequired
text
Referencetext
Output fields[3]
FieldType
IDtext
Statustext

Create an Applicant

Action
Input fields[3]
FieldType
External Applicant IDtext
Emailemail
External Applicant Nametext
Output fields[3]
FieldType
IDtext
Created ondate
Modified ondate
External applicant IDtext
Emailtext
External applicant nametext

Delete a Customer

Action
Input fields[3]
FieldType
Customer IDRequired
text

Enroll a Card in 3DS

Action
Input fields[3]
FieldType
Card IDRequired
text
Security PairRequired
object
Questiontext
Answertext
Phone NumberRequired
object
Country Codetext
Numbertext
Localetext

Increment Authorization

Action
Input fields[3]
FieldType
Payment IDRequired
choice
Amountnumber
Referencetext
Metadataobject
Coupon Codetext
Partner IDnumber
Output fields[3]
FieldType
Action IDtext
Amountnumber
Currencytext
Approvedboolean
Statustext
Auth codetext
Response codetext
Response summarytext
Expires ontext
Balancesobject
Total authorizednumber
Total voidednumber
Available to voidnumber
Total capturednumber
Available to capturenumber
Total refundednumber
Available to refundnumber
Processed ondate
Referencetext
Processingobject
Retrieval reference numbertext
Acquirer transaction IDtext
Recommendation codetext
Surcharge amountnumber
Ecitext
Scheme IDtext

Make an API Call

universal
Input fields[3]
FieldType
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Provide Dispute Evidence

Action
Input fields[3]
FieldType
Dispute IDRequired
choice
Proof of Delivery or Service Filetext
Proof of Delivery or Service Texttext
Proof of Delivery or Service Date Filetext
Proof of Delivery or Service Date Texttext
Invoice or Receipt Filetext
Invoice or Receipt Texttext
Invoice Showing Distinct Transactions Filetext
Invoice Showing Distinct Transactions Texttext
Customer Communication Filetext
Customer Communication Texttext
Refund or Cancellation Policy Filetext
Refund or Cancellation Policy Texttext
Recurring Transaction Agreement Filetext
Recurring Transaction Agreement Texttext
Additional Evidence Filetext
Additional Evidence Texttext
Arbitration No Review Filesarray
Arbitration No Review Texttext
Arbitration Review Required Filesarray

2other input fields

Refund a Payment

Action
Input fields[3]
FieldType
Payment IDRequired
choice
AmountRequired
number
ReferenceRequired
text
Amount Allocationsarray
Capture Action IDtext
Itemsarray
Destinationobject
Account Typetext
Account NumberRequired
text
Bank CodeRequired
text
Branch Codetext
IBANtext
BBANtext
SWIFT BICtext
CountryRequired
text
Account HolderRequired
object
Bankobject
Metadataarray
Keytext
Valuetext
Output fields[3]
FieldType
Action IDtext

Reverse a Payment

Action
Input fields[3]
FieldType
Payment IDRequired
choice
Referencetext
Metadataarray
Keytext
Valuetext
Output fields[3]
FieldType
Action IDtext

Submit Evidence

Action
Input fields[3]
FieldType
Dispute IDRequired
choice
Output fields[3]
FieldType
Request IDtext

Update a Cardholder

Action
Input fields[3]
FieldType
Cardholder IDRequired
text
First Nametext
Middle Nametext
Last Nametext
Date of Birthdate
Phone Numberobject
Country Codetext
Numbertext
Emailemail
Billing Addressobject
Address Line 1text
Address Line 2text
Citytext
Statetext
Ziptext
Countrytext
Residency Addressobject
Address Line 1text
Address Line 2text
Citytext
Statetext
Ziptext
Countrytext
Documentobject
Typetext
Front Document IDtext
Back Document IDtext
Output fields[3]
FieldType
Last modified datetext

Update a Customer

Action
Input fields[3]
FieldType
Customer IDRequired
text
Emailemail
Nametext
Phoneobject
Country Codetext
Numbertext
Metadataarray
Keytext
Valuetext
Defaulttext

Update an Applicant

Action
Input fields[3]
FieldType
Applicant IDRequired
text
Emailemail
External Applicant Nametext
Output fields[3]
FieldType
IDtext
Created ondate
Modified ondate
External applicant IDtext
Emailtext
External applicant nametext

Update Card Details

Action
Input fields[3]
FieldType
Card IDRequired
text
Referencetext
Metadataobject
User Defined Field 1text
User Defined Field 2text
User Defined Field 3text
User Defined Field 4text
User Defined Field 5text
Expiry Monthnumber
Expiry Yearnumber
Output fields[3]
FieldType
Last modified datetext

Upload a File

Action
Input fields[3]
FieldType
FileRequired
text
PurposeRequired
choice
Output fields[3]
FieldType
IDtext

Void a Payment

Action
Input fields[3]
FieldType
Payment IDRequired
choice
Referencetext
Metadataarray
Keytext
Valuetext
Output fields[3]
FieldType
Action IDtext

Look for Checkout templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Checkout Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Checkout.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:39

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.