NodeJS SDK - 2.1.0

June 24, 2026

Added

FlowDescriptor for declaring pay-in Beneficiaries

• New FlowDescriptor object (FlowId, Beneficiaries[].UserId) added to pay-in, recurring pay-in registration, card preauthorization, and deposit create/data typings, allowing beneficiary information to be passed

Read more in the API release note and dedicated guide →

Unified recurring pay-in method

New PayIns.createRecurringPayIn(recurringPayIn) method that creates a recurring pay-in for Card, PayPal, Apple Pay, and Google Pay using the same object structure as the non-recurring pay-in methods.

The method routes to the correct endpoint based on the payment and execution type:

• POST Create a Recurring Card PayIn
• POST Create a Recurring PayPal PayIn
• POST Create a Recurring Apple Pay PayIn
• POST Create a Recurring Google Pay PayIn

New recurring registration methods getRecurringPayInRegistration, updateRecurringPayInRegistration, and createRecurringPayInRegistration.

Read more about Apple Pay and Google Pay recurring payments →

Support for PayPal deposit preauthorizations

• New Deposits.createPayPalPreauthorization(deposit) method to call the POST Create a PayPal Deposit Preauthorization endpoint
• New PayPalDepositPreauthorization model and CreatePayPalDepositPreauthorization TypeScript typing (fields include PaypalPayerID, PaypalOrderID, Buyer*, Trackings, ShippingPreference, LineItems, DataCollectionId, etc.)
• New PayIns.createDepositPreauthorizedPayInWithoutComplement(payIn) method to call the POST Create a Deposit Preauthorized PayIn endpoint
• PayIns.createCardPreAuthorizedDepositPayIn is now deprecated in favour of createDepositPreauthorizedPayInWithoutComplement

Support for Email on webhooks

• The Hook model and hook typings now support an Email property on create and update (read more about email alerts for consecutive failed notifications)

DateRangeBy on Report V2

• The Report V2 model (ReportsV2.create) now supports the DateRangeBy field (e.g. "ExecutionDate"), with a matching DateRangeBy?: string typing on ReportV2Data

Virtual account local account fields

• LocalAccount typings gained BankCode, BSBCode, and BCNumber fields, with documentation updates to existing local account fields

Deprecated

Older recurring pay-in methods

The following are now deprecated (still functional) in favor of the unified methods above:

• createRecurringPayInRegistrationCIT, createRecurringPayInRegistrationMIT, createRecurringPayPalPayInCIT, createRecurringPayPalPayInMIT → use createRecurringPayIn
• getRecurringPayin → use getRecurringPayInRegistration
• updateRecurringPayin → use updateRecurringPayInRegistration
• createRecurringPayment → use createRecurringPayInRegistration

Changed

Dependency upgrades

• axios
  • 1.16.0 → 1.17.0
• form-data
  • 4.0.5 → 4.0.6