Hyfin icon

Hyfin

Payment processing platform for accepting, refunding, and managing customer payments.

4 searches8 actionsPollingAuth: API key

AI-assisted documentation7 min read

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

Open Hyfin on WEXTL →

Before you set up the credential, make sure you have an active Hyfin account and an API access token from your account settings ready.[3]

  • API KeytextRequired

    Only authorized users can access the APIs. In order to access the APIs, you must be an approved partner and have an API token assigned to you. To request an API Token, please email our API Support team at [email protected].

    [1]
  • Environmentselect
  1. Log in to your WEXTL account, add the Hyfin 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 Hyfin 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 Hyfin to WEXTL®
Video slide demonstrates how to integrate Hyfin in the WEXTL visual workflow builder.[4]

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 →

Get a CustomerAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
Customer IDRequired
text
Output fields[3]
FieldType
External IDtext
First Nametext
Last Nametext
Account Nametext
Mobile Phonetext
Emailtext
Notification Optionsobject
Notify Phoneboolean
Notify Emailboolean
Auto Payobject
Requestedboolean
Enabledboolean
Payment Token Displaytext
Get a PaymentAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
Payment IDRequired
text
Output fields[3]
FieldType
IDtext
External IDtext
Payment Typetext
Payment Sub Typetext
Display Nametext
Last 4text
Totalnumber
Paid Ontext
Statustext
Transaction Typetext
Activeboolean
Get a SubscriptionAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
Subscription IDRequired
text
Output fields[3]
FieldType
External IDtext
Descriptiontext
Amountnumber
Frequencytext
Start Datetext
Number Of Paymentstext
End Datetext
Invoicesarray
Statustext
Customerobject
External IDtext
First Nametext
Last Nametext
Account Nametext
Mobile Phonetext
Emailtext
Notification Optionsobject
Activeboolean
Get an InvoiceAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
Invoice IDRequired
text
Output fields[3]
FieldType
External IDtext
Invoice Numbertext
Descriptiontext
Customer Memotext
Internal Memotext
Due Datetext
Totalsobject
Taxnumber
Totalnumber
Customerobject
External IDtext
First Nametext
Last Nametext
Mobile Phonetext
Emailtext
Linesarray
Paymentsarray
Notificationsarray
Webhook URLurl
Add / Update a CustomerAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
External IDRequired
text
First NameRequired
text
Last NameRequired
text
Account Nametext
Mobile Phonetext
Emailemail
Notestext
Activeboolean
Notification Optionsobject
Notify Phoneboolean
Notify Emailboolean
Output fields[3]
FieldType
Successboolean
Actiontext
Customer IDtext
Add / Update a ProductAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
External IDRequired
text
Product NameRequired
text
Unit PriceRequired
number
Activeboolean
Output fields[3]
FieldType
Successboolean
Actiontext
Product IDtext
Add / Update a SubscriptionAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
External IDRequired
text
DescriptionRequired
text
AmountRequired
number
FrequencyRequired
choice
Frequency UnitsRequired
number
CustomerRequired
object
Customer External IDRequired
text
First Nametext
Last Nametext
Account Nametext
Mobile Phonetext
Emailemail
Notestext
Customer Activeboolean
Notification Optionsobject
Start Datedate
Number of Paymentsnumber
Activeboolean
Statuschoice
Output fields[3]
FieldType
Successboolean
Actiontext
Subscription IDtext
Add / Update an InvoiceAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
External IDRequired
text
Invoice NumberRequired
text
Descriptiontext
Totalsobject
Taxnumber
TotalRequired
number
Customerobject
Customer External IDRequired
text
First Nametext
Last Nametext
Account Nametext
Mobile Phonetext
Emailemail
Notestext
Customer Activeboolean
Notification Optionsobject
Line Itemsarray
Unit Pricenumber
Quantitynumber
Total Pricenumber
Descriptiontext
Productobject
Invoice Datedate
Due Datedate
Expire Atdate
PO Numbertext
Customer Memotext
Internal Memotext
Invoice Activeboolean
Paymentsarray
Payment External IDRequired
text
Gateway Transaction IDtext
Display Nametext
Amountnumber
Paid Ondate
Tipnumber
Payment Typetext
Payment Sub Typetext
Check Numbertext
Statustext
Webhook URLurl
Attachmentsarray
A valid URL.url
Optionsobject
Tipping Enabledboolean
Cash Discount Disabledboolean
Resendboolean
Output fields[3]
FieldType
Successboolean
Actiontext
Invoice IDtext
Linkurl
Make an API Calluniversal
Input fields[3]
FieldType
MethodRequired
choice
Headersarray
Keytext
Valuetext
Query Stringarray
Keytext
Valuetext
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Refund a PaymentAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
Payment IDRequired
text
AmountRequired
number
Reasontext
Output fields[3]
FieldType
Successboolean
Send an InvoiceAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
External IDRequired
text
Output fields[3]
FieldType
Successboolean
Actiontext
Void a PaymentAction
Input fields[3]
FieldType
By Site ID or Merchant IDRequired
choice
Payment IDRequired
text
Reasontext
Output fields[3]
FieldType
Successboolean

Look for Hyfin templates in the WEXTL template library.

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

Last updated: Jul 24, 2026 18:11