Skip to navigation

v1.0.19

This release includes breaking changes. The get payout subscription response now uses its own camelCase types. See October 14, 2026 for more information.

New types in the get payout subscription response

Payabli.PayoutSubscriptionQueryRecord now uses new types for its vendor, bills, and payment data:

PropertyBeforeAfter
vendorPayabli.VendorQueryRecordPayabli.PayoutSubscriptionVendor
billDataPayabli.BillPayOutData[]Payabli.PayoutSubscriptionBill[]
paymentDataPayabli.QueryPaymentDataPayabli.PayoutSubscriptionPaymentData

paymentData.paymentDetails is a Payabli.PayoutSubscriptionPaymentDetails.

The new types also use the API’s camelCase property names, so property access changes along with the type names:

// Before
const vendor: Payabli.VendorQueryRecord | undefined = sub.responseData?.vendor;
const vendorNumber = vendor?.VendorNumber;
// After
const vendor: Payabli.PayoutSubscriptionVendor | undefined = sub.responseData?.vendor;
const vendorNumber = vendor?.vendorNumber;
  • vendor: VendorNumber, Name1, Name2, EIN, Phone, Email, RemitEmail, Address1, Address2, City, State, Zip, Country, Mcc, LocationCode, Contacts, BillingData, PaymentMethod, VendorStatus, VendorId, EnrollmentStatus, Summary, PaypointLegalname, PaypointId, PaypointDbaname, PaypointEntryname, ParentOrgName, ParentOrgId, CreatedDate, LastUpdated, InternalReferenceId, PaymentPortalUrl, CardAccepted, AchAccepted, CheckAccepted, EnrichmentStatus, EnrichedBy, EnrichedAt, EnrichmentId, and StoredMethods are now camelCase, such as vendorNumber, ein, and storedMethods.
  • vendor.contacts: ContactName, ContactEmail, ContactTitle, and ContactPhone are now contactName, contactEmail, contactTitle, and contactPhone.
  • billData: LotNumber, AccountingField1, AccountingField2, Terms, and AdditionalData are now lotNumber, accountingField1, accountingField2, terms, and additionalData.
  • paymentData: AccountExp, AccountType, AccountZip, HolderName, Initiator, MaskedAccount, Sequence, SignatureData, StoredId, and StoredMethodUsageType are now camelCase, such as maskedAccount and holderName.

New payment data type in list payout subscriptions

PayoutSubscriptionQueryRecordPascal.PaymentData is now a Payabli.PayoutSubscriptionPaymentDataPascal instead of a Payabli.QueryPaymentData.

Nullable fields

These fields now include | null, which affects code that reads them under strict:

  • BillPayOutData: billId, AccountingField1, AccountingField2, Terms, attachments, comments, discount
  • BillingDataResponse.accountId
  • PayoutSubscriptionQueryRecord.events
  • PayoutSubscriptionQueryRecordPascal.Events

New fields on payout subscriptions

PayoutSubscriptionQueryRecord adds sameDayAch, doNotCreateBills, allowDuplicatedBills, autoConvertSameDayAch, and subscriptionType. PayoutSubscriptionQueryRecordPascal adds the same fields in PascalCase, such as SameDayAch. PayoutSubscriptionPaymentData adds walletType and payorSignature, PayoutSubscriptionPaymentDataPascal adds WalletType and payorSignature, and PayoutSubscriptionPaymentDetails adds the payout details fields, such as orderId, payabliTransId, and surchargeFee.

Vendor record changes

VendorQueryRecord.StoredMethods is now a Payabli.VendorStoredMethod[] | null. VendorStoredMethod extends VendorResponseStoredMethod and adds IsDefault. VendorQueryRecord adds VendorPortal (Payabli.VendorPortalAccess | null), and BillingDataResponse adds country.