Twikey icon

Twikey

Direct debit and recurring payment collection for businesses.

7 triggers28 searches40 actionsInstant (webhooks)Auth: OAuth

AI-assisted documentation20 min read

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

Open Twikey on WEXTL →

To use Twikey on WEXTL you need an active account and OAuth client credentials, granted by signing in with your account.[3]

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

  • API KeypasswordRequired

    Enter your API key from the Merchant Dashboard.

    [1]
  • One-Time Password (Optional)text

    Only required if enhanced security is enabled on your account.

    [1]
  1. Log in to your WEXTL account, add the Twikey node module to your workflow, and click Create new credential.
    Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Twikey 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 →

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 →

Watch EventTrigger

No fields documented.

Watch InvoicesTrigger
Output fields[3]
FieldType
Invoice IDtext
Numbertext
Titletext
Remittancetext
Reftext
Statetext
Amountnumber
Datedate
Duedatedate
Ctnumber
URLurl
Watch Mandate FeedTrigger
Output fields[3]
FieldType
Mndtobject
Mndt IDtext
Lcl instrmtext
Ocrncsobject
Cdtr schme IDtext
Cdtrobject
Dbtrobject
Dbtr accttext
Dbtr agtobject
Rfrd doctext
Splmtry dataarray
Evt timetext
Watch Payment LinksTrigger
Watch PaymentsTrigger
Output fields[3]
FieldType
Event IDtext
Event typetext
Occurred atdate
Amountnumber
Currencytext
Originobject
Objecttext
IDtext
Numbertext
Reftext
Gatewayobject
IDnumber
Nametext
Typetext
Ibantext
Detailsobject
Sourcetext
Payment IDnumber
Transaction e2etext
Mndt IDtext
Watch SubscriptionsTrigger
Output fields[3]
FieldType
Subscription IDnumber
Statetext
Amountnumber
Messagetext
Reftext
Plannumber
Runsnumber
Stop afternumber
Startdate
Lastdate
Nextdate
Recurrencetext
Mndt IDtext
Watch TransactionsTrigger
Output fields[3]
FieldType
Transaction IDnumber
Contract IDnumber
Mndt IDtext
Contracttext
Amountnumber
Msgtext
Placetext
Reftext
Finalboolean
Statetext
Bkdatedate
Reqcolldtdate
Get a Credit TransferAction
Input fields[3]
FieldType
Transfer IDRequired
text
Output fields[3]
FieldType
Credit Transfer IDtext
Ibantext
Bictext
Amountnumber
Msgtext
Placetext
Reftext
Datedate
Statetext
Bkdatedate
Get a MandateAction
Input fields[3]
FieldType
Mandate IDRequired
choice
Include Non-Signed Statesboolean
Output fields[3]
FieldType
Mndtobject
Mndt IDtext
Lcl instrmtext
Ocrncsobject
Cdtr schme IDtext
Cdtrobject
Dbtrobject
Dbtr accttext
Dbtr agtobject
Rfrd doctext
Splmtry dataarray
Evt timetext
Get a Mandate PDFAction
Input fields[3]
FieldType
Mandate IDRequired
choice
Get a SubscriptionAction
Input fields[3]
FieldType
MandateRequired
choice
Subscription ReferenceRequired
choice
Output fields[3]
FieldType
Subscription IDnumber
Statetext
Amountnumber
Messagetext
Reftext
Plannumber
Runsnumber
Stop afternumber
Starttext
Lasttext
Nexttext
Recurrencetext
Mndt IDtext
Get a UBL FileAction
Input fields[3]
FieldType
InvoiceRequired
choice
Get Account ReportingAction
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Account Reporting IDnumber
Typetext
Datedate
Amountnumber
Ibantext
Bictext
Msgtext
Mndt IDtext
Partytext
Get an Identification URLAction
Input fields[3]
FieldType
Template ID (IDENT)Required
text
Identification MethodRequired
choice
Bank BIC (Required for iDIN)text
Languagetext
Get an InvoiceAction
Input fields[3]
FieldType
Invoice ID or NumberRequired
choice
Includearray
Output fields[3]
FieldType
Invoice IDtext
Numbertext
Titletext
Remittancetext
Reftext
Statetext
Amountnumber
Datedate
Duedatedate
Ctnumber
URLurl
Get an Invoice PDFAction
Input fields[3]
FieldType
InvoiceRequired
choice
Get Batch DetailsAction
Input fields[3]
FieldType
Batch IDtext
Payment Identifier (PmtInfId)text
Output fields[3]
FieldType
IDnumber
Pmtinfidtext
Progresstext
Entriesnumber
Get Bulk Batch DetailsSearch
Input fields[3]
FieldType
Batch IDRequired
text
Limitnumber
Output fields[3]
FieldType
Bulk Batch IDnumber
Reftext
Mndt IDtext
Statustext
Get Bulk Batch Invoice DetailsSearch
Input fields[3]
FieldType
Batch IDRequired
text
LimitRequired
number
Output fields[3]
FieldType
IDtext
Statustext
Get Legal TermsAction
Input fields[3]
FieldType
Localechoice
Output fields[3]
FieldType
Tc URLtext
By signingtext
Rights coretext
Rights b2btext
Info correcttext
Get Payment Link StatusAction
Input fields[3]
FieldType
Payment Link IDchoice
Payment Referencetext
Include Additional Datachoice
Output fields[3]
FieldType
Payment Link IDnumber
Amountnumber
Msgtext
Reftext
Statetext
Get Transaction StatusAction
Input fields[3]
FieldType
Transaction IDchoice
Referencetext
Mandate IDchoice
Statechoice
Include Additional Datachoice
Limitnumber
Output fields[3]
FieldType
Transaction IDnumber
Contract IDnumber
Mndt IDtext
Contracttext
Amountnumber
Adminchargenumber
Msgtext
Placetext
Reftext
Datetext
Finalboolean
Statetext
Bkerrortext
Bkmsgtext
Bkdatedate
Lastupdatedate
4other output fields
List Beneficiary AccountsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Nametext
Ibantext
Bictext
Availableboolean
Addresstext
List Blacklisted AccountsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Ibantext
Rsntext
List Credit TransfersSearch
Input fields[3]
FieldType
Include Sequence Numberchoice
Limitnumber
Output fields[3]
FieldType
Credit Transfer IDtext
Ibantext
Bictext
Amountnumber
Msgtext
Placetext
Reftext
Datetext
List Invoice FeedSearch
Input fields[3]
FieldType
Includearray
Limitnumber
Output fields[3]
FieldType
Invoice IDtext
Numbertext
Titletext
Remittancetext
Reftext
Statetext
Amountnumber
Datedate
Duedatedate
Ctnumber
URLurl
List Mandate FeedSearch
Input fields[3]
FieldType
Resume After Sequence IDtext
Mandate Typeschoice
Include Additional Datachoice
Limitnumber
Output fields[3]
FieldType
Mndtobject
Mndt IDtext
Lcl instrmtext
Ocrncsobject
Cdtr schme IDtext
Cdtrobject
Dbtrobject
Dbtr accttext
Dbtr agtobject
Rfrd doctext
Splmtry dataarray
Evt timetext
List Payment FeedSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Event IDtext
Event typetext
Occurred atdate
Amountnumber
Currencytext
Originobject
Objecttext
IDtext
Numbertext
Reftext
Gatewayobject
IDnumber
Nametext
Typetext
Ibantext
Detailsobject
Sourcetext
Payment IDnumber
Transaction e2etext
Mndt IDtext
List Payment Link FeedSearch
Input fields[3]
FieldType
Include All Statesboolean
Include Additional Datachoice
Limitnumber
Output fields[3]
FieldType
Payment Link IDnumber
Ctnumber
Amountnumber
Msgtext
Reftext
Statetext
Customerobject
IDnumber
Emailemail
Firstnametext
Lastnametext
Addresstext
Citytext
Ziptext
Countrytext
Customer numbertext
Ltext
Metaobject
Activeboolean
Sddtext
Txtext
Timeobject
Creationdate
Expirationtext
Lastupdatedate
List Payment MethodsSearch
Input fields[3]
FieldType
Profile ID (ct)Required
number
Limitnumber
List Reconciliation FilesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Nametext
Createddate
List SubscriptionsSearch
Input fields[3]
FieldType
Mandatechoice
Customer Numbertext
Statechoice
Limitnumber
Output fields[3]
FieldType
Subscription IDnumber
Statetext
Amountnumber
Messagetext
Reftext
Plannumber
Runsnumber
Stop afternumber
Starttext
Lasttext
Nexttext
Recurrencetext
Mndt IDtext
List Transaction FeedSearch
Input fields[3]
FieldType
Include Additional Datachoice
Limitnumber
Output fields[3]
FieldType
Transaction IDnumber
Contract IDnumber
Mndt IDtext
Contracttext
Amountnumber
Adminchargenumber
Msgtext
Placetext
Reftext
Datetext
Finalboolean
Statetext
Bkerrortext
Bkmsgtext
Bkdatetext
Lastupdatetext
5other output fields
Query TransactionsSearch
Input fields[3]
FieldType
Start From Transaction IDRequired
number
Mandate IDchoice
Limitnumber
Output fields[3]
FieldType
Transaction IDnumber
Contract IDnumber
Ctnumber
Subscription IDnumber
Mndt IDtext
Amountnumber
Msgtext
Placetext
Reftext
Datedate
Finalboolean
Statetext
Bkdatetext
Lastupdatedate
Collectionnumber
Search MandatesSearch
Input fields[3]
FieldType
IBANtext
Customer Numbertext
Emailemail
Contract Statechoice
Limitnumber
Output fields[3]
FieldType
Mandate IDnumber
Typetext
Statetext
Suspendedboolean
PDF availableboolean
Mandate numbertext
Contract numbertext
Ctnumber
Sign datedate
Ibantext
Bictext
Attributesobject
Vehicletext
Kmtext
Batch Create Credit TransfersAction
Input fields[3]
FieldType
Originating Account IBANRequired
text
Output fields[3]
FieldType
IDnumber
Pmtinfidtext
Entriesnumber
Blacklist an AccountAction
Input fields[3]
FieldType
IBANRequired
text
ReasonRequired
text
Mandate Actionchoice
Notify Customerboolean
Cancel a SubscriptionAction
Input fields[3]
FieldType
MandateRequired
choice
Subscription ReferenceRequired
text
Cancel AgreementsAction
Input fields[3]
FieldType
Mandate IDRequired
choice
Cancellation ReasonRequired
text
Notify Customer by Emailboolean
Check an IBAN NameAction
Input fields[3]
FieldType
IBANRequired
text
Integration Typechoice
Account Holder Name (NL only)text
Fiscal Code (IT only)text
VAT Number (IT only)text
Output fields[3]
FieldType
Ibanobject
Foundboolean
Validboolean
Black listedboolean
Name matchingboolean
Nameobject
Validboolean
Suggestiontext
Accountobject
Foreignboolean
Country codetext
Activeboolean
Holder typetext
Holder residence municipalitytext
Holder official nametext
Holders numbernumber
Holder joint accountboolean
Create a Beneficiary AccountAction
Input fields[3]
FieldType
Customer Numbertext
Customer Emailemail
Customer Nametext
Language (ISO 2-letter)text
Mobile Numbertext
Street Addresstext
Citytext
ZIP Codetext
Country Codetext
Company Nametext
VAT / Enterprise Numbertext
Beneficiary IBANRequired
text
Beneficiary BICtext
Output fields[3]
FieldType
Nametext
Ibantext
Bictext
Availableboolean
Addressobject
Streettext
Citytext
Ziptext
Countrytext
Create a Credit TransferAction
Input fields[3]
FieldType
Customer NumberRequired
text
IBANtext
Transfer MessageRequired
text
AmountRequired
number
Referencetext
Execution Datetext
Placetext
Idempotency Keytext
Output fields[3]
FieldType
Credit Transfer IDtext
Ibantext
Bictext
Amountnumber
Msgtext
Placetext
Reftext
Datetext
Create a Payment LinkAction
Create a SubscriptionAction
Input fields[3]
FieldType
Mandate IDRequired
choice
MessageRequired
text
Referencetext
Plan Nametext
Amountnumber
Stop Afternumber
Recurrencechoice
Start DateRequired
date
Idempotency Keytext
Output fields[3]
FieldType
Subscription IDnumber
Statetext
Amountnumber
Messagetext
Reftext
Plannumber
Runsnumber
Stop afternumber
Starttext
Nexttext
Recurrencetext
Mndt IDtext
Create a TransactionAction
Input fields[3]
FieldType
MandateRequired
choice
MessageRequired
text
AmountRequired
number
Transaction Datedate
Requested Collection Datedate
Referencetext
Placetext
Use as End-to-End Referenceboolean
Idempotency Keytext
Output fields[3]
FieldType
Transaction IDnumber
Contract IDnumber
Mndt IDtext
Contracttext
Amountnumber
Msgtext
Placetext
Reftext
Datedate
Create an InvoiceAction
Input fields[3]
FieldType
Invoice NumberRequired
text
AmountRequired
number
Invoice DateRequired
date
Due DateRequired
date
Invoice UUIDtext
Titletext
Remittancetext
Internal Referencetext
Contract Template (CT)text
Invoice Languagechoice
Customerobject
Customer Numbertext
Emailemail
First Nametext
Last Nametext
Company Nametext
Enterprise Numbertext
VAT Numbertext
Customer Languagetext
Addresstext
Citytext
Customer by Mandatechoice
Customer by Customer Numbertext
Manual Invoiceboolean
PDF (Base64)text
PDF URLurl
8other input fields
Output fields[3]
FieldType
Invoice IDtext
Numbertext
Titletext
Ctnumber
Amountnumber
Datedate
Duedatedate
Statetext
URLurl
Create Invoices in BulkAction
Input fields[3]
FieldType
InvoicesRequired
array
Invoice NumberRequired
text
AmountRequired
number
Invoice DateRequired
date
Due DateRequired
date
Titletext
Remittancetext
Internal Referencetext
Contract Templatetext
Language (e.g. en, nl, fr_fr)text
Mandate IDtext
Purposechoice
Partner Labeltext
Force Transactionboolean
Output fields[3]
FieldType
Batch IDtext
Create Multiple TransactionsAction
Input fields[3]
FieldType
TransactionsRequired
array
Mandate IDRequired
choice
MessageRequired
text
Transaction Datedate
Requested Collection Datedate
AmountRequired
number
Referencetext
Placetext
Use as End-to-End Referenceboolean
Output fields[3]
FieldType
Batch IDtext
Delete a Credit TransferAction
Input fields[3]
FieldType
Transfer ID (E2E Reference)Required
text
Delete a Payment LinkAction
Delete a TransactionAction
Input fields[3]
FieldType
Transaction IDchoice
Referencetext
Delete an InvoiceAction
Input fields[3]
FieldType
Invoice IDRequired
choice
Disable a Beneficiary AccountAction
Input fields[3]
FieldType
Beneficiary IBANRequired
text
Customer Numbertext
Download a Reconciliation FileAction
Input fields[3]
FieldType
FilenameRequired
text
Execute a Mandate ActionAction
Input fields[3]
FieldType
Mandate IDRequired
choice
Action TypeRequired
choice
Reminder Numberchoice
Generate Customer Access LinkAction
Generate Reconciliation FilesAction
Input fields[3]
FieldType
Generate Direct Debit FilesRequired
boolean
Generate Payment Link FilesRequired
boolean
File Formatchoice
Invite a Customer to a MandateAction
Input fields[3]
FieldType
Template ID (ct_id)Required
number
Languagechoice
IBANtext
BICtext
Mandate Numbertext
Customer Numbertext
Emailemail
Last Nametext
First Nametext
Mobile (International Format)text
Addresstext
Citytext
Zip Codetext
Country (ISO 2-letter)text
Company Nametext
VAT Numbertext
20other input fields
Output fields[3]
FieldType
Mndt IDtext
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Perform a Transaction ActionAction
Input fields[3]
FieldType
Transaction IDRequired
choice
ActionRequired
choice
Perform an Action on a SubscriptionAction
Input fields[3]
FieldType
MandateRequired
choice
Subscription ReferenceRequired
choice
ActionRequired
choice
Perform an Action on an InvoiceAction
Input fields[3]
FieldType
InvoiceRequired
choice
Action TypeRequired
choice
Initial Amountnumber
Recurring Amountnumber
Terms (Months)number
Mandate IDchoice
Refund a Payment LinkAction
Refund a TransactionAction
Input fields[3]
FieldType
Transaction IDRequired
choice
Refund MessageRequired
text
AmountRequired
number
Referencetext
Placetext
IBANtext
BICtext
Idempotency Keytext
Output fields[3]
FieldType
Transaction IDtext
Ibantext
Bictext
Amountnumber
Msgtext
Placetext
Reftext
Datetext
Remove a Blacklisted AccountAction
Input fields[3]
FieldType
IBANRequired
text
Reactivate Mandateschoice
Notify Customerboolean
Sign a MandateAction
Input fields[3]
FieldType
Signature MethodRequired
choice
Template ID (ct_id)Required
number
Invite Shortcodetext
IBANtext
BICtext
Emailtext
Last Nametext
First Nametext
Mobile (International Format)text
Addresstext
Citytext
Zip Codetext
Country (ISO 2-letter)text
Place of Signaturetext
Signature Datedate
Digital Signature (Base64 PNG)text
4other input fields
Output fields[3]
FieldType
Mndt IDtext
URLurl
Update a CustomerAction
Input fields[3]
FieldType
Customer NumberRequired
text
First Nametext
Last Nametext
Emailemail
Mobile Numbertext
Addresstext
Citytext
ZIP Codetext
Country Codetext
Company Nametext
Enterprise Numbertext
Default Templatenumber
Languagechoice
New Customer Numbertext
Update a MandateAction
Input fields[3]
FieldType
Mandate IDRequired
choice
Template IDnumber
Mandate Statechoice
Mobile Numbertext
IBANtext
BICtext
Customer Numbertext
Emailemail
First Nametext
Last Nametext
Company Nametext
Enterprise Numbertext
Languagechoice
Street Addresstext
Citytext
Zip Codetext
1other input field
Update a SubscriptionAction
Input fields[3]
FieldType
Mandate (Path)Required
choice
Subscription ReferenceRequired
text
Move to Mandatechoice
Messagetext
Amountnumber
Output fields[3]
FieldType
Subscription IDnumber
Statetext
Amountnumber
Messagetext
Reftext
Plannumber
Runsnumber
Stop afternumber
Starttext
Nexttext
Recurrencetext
Mndt IDtext
Update a SubscriptionAction
Input fields[3]
FieldType
Mandate (Path)Required
choice
Subscription ReferenceRequired
text
Mandate IDRequired
choice
Start DateRequired
date
MessageRequired
text
AmountRequired
number
Recurrencechoice
Stop Afternumber
Plan Nametext
Output fields[3]
FieldType
Subscription IDnumber
Statetext
Amountnumber
Messagetext
Reftext
Plannumber
Runsnumber
Stop afternumber
Starttext
Nexttext
Recurrencetext
Mndt IDtext
Update a TransactionAction
Input fields[3]
FieldType
Transaction IDRequired
choice
Requested Collection Datedate
Messagetext
Referencetext
Amountnumber
Placetext
Update an InvoiceAction
Input fields[3]
FieldType
Invoice IDRequired
choice
Invoice DateRequired
date
Due DateRequired
date
Titletext
Referencetext
PDF (Base64)text
Invoice Statechoice
Extra Attributesobject
Output fields[3]
FieldType
Invoice IDtext
Numbertext
Titletext
Remittancetext
Reftext
Statetext
Amountnumber
Datedate
Duedatedate
Ctnumber
URLurl
Update Transaction ReservationsAction
Input fields[3]
FieldType
Reservation ModeRequired
boolean
Reservation Minimumnumber
Reservation Expirationtext
Output fields[3]
FieldType
Codetext
Messagetext
Over amounttext
Rule amounttext
Ruletext
Tx amounttext
Upload a Mandate PDFAction
Input fields[3]
FieldType
Mandate IDRequired
choice
Mandate PDF FileRequired
file
Include Bank Signatureboolean
Upload a UBL FileAction
Input fields[3]
FieldType
UBL XML ContentRequired
text
Manual Invoiceboolean
Custom Invoice UUIDchoice
Template IDnumber
Mandate IDchoice
Partner Labeltext
Custom Attributesobject
Attribute Nametext
Valuetext
Output fields[3]
FieldType
IDtext
Numbertext
Titletext
Remittancetext
Reftext
Statetext
Amountnumber
Datedate
Duedatedate
Ctnumber
URLurl

Look for Twikey templates in the WEXTL template library.

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

Last updated: Jul 24, 2026 18:13