2023 API and UI Changelog

Web app

These changes impact PartnerHub, PayHub, or both.

• Made minor UI improvements to the Batch & Transfer report:
  • Changed the Funding Status label to Batch Status for clarity
  • Added better empty state messages
  • Added a column for Split Amount
• Improved custom field validation to help avoid issues caused by the space character
• Improved logo behavior on several screens
• Fixed an issue that caused a mismatch between transaction statuses on payout transactions run with the payout Creator components

API

These changes impact the Payabli APIs.

• Added BatchSplitAmount to the batch query response
• Added TransferDate to the batch query and export responses
• Added validation and better error messaging for attempted refunds on transactions with an ACH return or chargeback
• Added new TransferReturn notification to alert when a transfer has been returned, commonly due to insufficient funds or problems with the external bank account. See TransferReturn for more
• Improved validation for comment fields in bills, which fixes an issue with payout requests failing because of special characters
• Fixed an issue with column alignment on Batches & Funding exports
• Fixed an issue with inconsistencies in payout batch statuses

Payabli is excited to announce new split funding functionality. With split funding, you can distribute the funds from a single transaction to different bank accounts and paypoints by sending split instructions with the transaction request.

This example shows an example transaction with the splitFunding array, which contains the split instructions.

If you want to use this feature, reach out to the Payabli team. We’ll work with you to understand your use case and create the best configuration for your needs.

See the documentation for split funding to learn more and to find examples:

• Fund Routing Overview: Learn more about your options for routing funds with Payabli
• Split Funds from a Transaction: Learn how to send split instructions with a transaction
• Refund a Split Funded Transaction: Learn how to refund a split transaction

Web app

These changes impact PartnerHub, PayHub, or both.

Creator updates (beta)

• Added the ability to set border radius to 0
• Fixed minor style inheritance issue with boarding components in Creator
• Fixed an issue that caused an error when continuing a Creator session after a timeout warning. Sessions now continue as expected
• Fixed an issue with footer button transparency

General enhancements

• Increased the custom field character limit in Payment Links from 250 to 1000 characters
• Fixed character alignment in some badges in Money Out reports
• Updated “Entry Name” column to “Entry Point” to align with the API
• Clarified the text on the Create a Token modal
• Made minor UX improvements to the Vendor screen
• Added a TemplateID column to the Templates screen
• Added ability to filter ACH Returns & Chargebacks and Transaction report by custom fields
• Improved bill screen UI on tablets and mobile devices
• Improved UI responsiveness for some reports
• CAPTCHA improvements detailed
• Fixed various issues including those with transaction reports, payment links, and notification emails

Boarding

Notes & Events

We’re excited to announce the new Notes & Events feature for boarding applications. This feature lets you collaborate with the Payabli team through notes and receive updates as an application moves through the boarding process.

To use Notes & Events, head to your Applications screen, and hover over the icon in the Notes & Events column. You can also open an application and click the Notes & Events tab.

Other boarding updates

• Made minor UX improvements to boarding applications and the boarding link screen
• Added a new column for Notes & Events with filtering capability
• Improved validation for the Owner Date of Birth field
• Improved handling of sections marked not visible on templates
• Fixed bug with file drag-and-drop in applications
• Fixed issues with boarding email notifications
• Fixed error message when editing business details
• Fixed email field issues when sending applications
• Fixed ACH return notification email subject line
• Fixed blank screen bug when navigating to paypoint from PartnerHub

Embedded components

New library versioning

We’ve adopted semantic versioning for embedded components. The sandbox library URL is now evergreen, while production environments require explicit version declaration in X.X.X format. Beginning October 22, 2023, versions older than 1.9.0 are no longer supported.

Other changes

• Added ability to toggle JCB and Diner’s Club cards acceptance via the card configuration object:

  {
    "enabled": true,
    "amex": true,
    "discover": true,
    "visa": true,
    "mastercard": true,
    "diners": true,
    "jcb": false
  }
  

• Improved card validation for Diners Club cards

API

• Increased custom field character limit from 250 to 1000 characters
• Added isHold filter to various API endpoints
• Added new parameters to the Summary object for Query/transferDetails and Query/settlement endpoints
• Fixed issues with last_modified timestamp, notification failures, and MoneyIn/reverse operation

Web app

Creator updates (beta)

• Removed erroneous console error messages
• Added copy button to color picker values in the editor

UI updates

• Added View Check button to the Bill Details screen for viewing check images
• Made navigation heading improvements
• General icon tweaks and enhancements
• Fixed several issues:
  • Entering digits in Transaction report filters now works as expected
  • Field display on boarding applications
  • User status badge display
  • 404 error when adding payment methods from customer records
  • Date picker logic for operations with start/end dates
  • Pagination in Residuals report
  • Organizations report 500 error

Embedded components

• Fixed an issue that returned a 401 error when a customer tries to make multiple payments

API

New saveIfSuccess option

We’ve added a new option to the /getPaid endpoint that allows you to tokenize and save the payment method on any successfully authorized transaction with a card, device, or ACH payment method.

To tokenize a payment method while making a sale transaction, pass saveIfSuccess: true in the paymentMethod object. The new tokenized payment method will be returned in the response if the transaction is successful. If successful, the request returns the new method’s reference ID as methodReferenceId.

Other API fixes

• Fixed blank Billing & Fees column in exports
• Fixed 500 error when saving previously saved boarding applications
• Fixed Organizations query 500 error

Web app

Creator Updates (Beta)

• Pay in components can now be used to accept payments
• Fixed several small UI bugs with the editor

UI Updates

• Added Fee and Total fields to the Transaction Details quick view screen on Batch reports
• Minor UI improvements to report emails

Boarding Updates

• Fixed login errors for applicants accessing saved applications
• Added Average Monthly Volume and Annual Revenue Volume fields to templates and fixed several labels
• Fixed e-sign errors in certain template situations
• Fixed template header visibility logic

Bug Fixes

• Fixed vendor payment links failing in sandbox
• Added proper error message for paypoint users trying to log in at partner level
• Fixed batch status filters to update automatically without refresh

Embedded components

Version updated to v1.9 with:

• Fixed several small usability bugs with VirtualTerminal

API

Enhancements

• Added templateId and boardingLinkId to boarding application endpoint responses
• Improved speed of Organization exports in XLSX format
• Added connectorName filter and field in transaction query and export endpoints
• Added gateway column to batch query and batch export
• Added ability to save new payment methods without customer information

Bug Fixes

• Fixed embedded components callback functions being called multiple times
• Fixed customer list exports limitation of 20 records; now returns correct number of filtered customers

Web app

Creator updates (beta)

• Data column selections and ordering are now persistent - when you modify columns in a reporting component, the changes are retained

UI updates

• Enhanced badges and icons in filter panel, logs, user reports, and My Profile sections
• Improved UI text and added more tooltips to the API token creation modal

API

Enhancements

• Transaction report exports now default to including only the last two months of data when no date range is specified

Bug fixes

• Fixed query requests error when a record had null event data

Web app

Bill and invoice details screens

Added enhanced quick view screens for bills and invoices, allowing you to see important details faster from report screens.

Creator updates (beta)

• Domain requirement now enforced - when using hosted setup, API token must be configured with your domain instead of http://localhost
• Added boarding components for testing embeddable boarding applications
• Added ability to delete reporting components
• UX improvements to reporting components:
  • Improved responsive behavior for tables
  • Fixed fonts and color display issues
  • Added clear all filters button
  • Various minor improvements

General UI updates

• Updated notification email language for clarity and skimmability
• Improved Vendor screens usability
• Added paypoint link to chargeback screens
• Various label and navigation updates

Bug fixes

• Fixed business start date display in boarding templates
• Fixed customer name display in reports when last name is empty
• Fixed MCC display in boarding templates
• Fixed vendor and additional email address sending
• Fixed password reset link display in Outlook
• Fixed custom notes display on invoices
• Fixed rotating icon colors
• Fixed blank screen navigation in boarding app
• Fixed receipt field configuration
• Fixed loading state display in reports
• Fixed user editing from Organizations page

API

New webhook failure notifications

Added new notifications for failed webhooks:

• FailedWebNotification for web notification failures
• FailedSMSNotification for SMS notification failures
• FailedEmailNotification for email notification failures

Note: Target type cannot match notification type (e.g., can’t send FailedSMSNotification via SMS)

Notification bodies include:

• SMS: phone number, paypoint, event
• Email: email address, paypoint, event
• Web: URL, paypoint, event

Use Add notification endpoint to configure.

Other enhancements

• Added new batch query filters. See List batches for a paypoint and List batches for an organization

Business name in boarding application emails

When you get a new boarding application notification email, the merchant business name now appears in the subject line.

ZIP fields support Canadian postal codes

Added support for six-character Canadian Postal codes across:

• Customer, vendor, and invoice records
• Boarding applications and templates
• Payment pages and virtual terminals

Enhanced batch reports

Added new columns to batch reports:

• Service Fee
• Net Batch
• Held Amount
• Release Amount
• Gross Batch

Webhook header customization

You can now add custom web header parameters for webhook notifications to enhance security and filtering.

General UI enhancements

• Improved embedded component label spacing
• Added combined payment methods icon in transaction reports
• Improved small screen report viewing

Bug fixes

Invoice related

• Fixed invoice created date changing on open/print
• Fixed custom fields and identifiers saving in Settings
• Fixed cash payment invoice status updates
• Fixed new customer creation from invoice records
• Fixed invoice sending from PartnerHub

Navigation and display

• Fixed Approvals report navigation
• Fixed receipt field customization display
• Fixed Failed filter in transactions report
• Fixed Virtual Terminal device loading
• Fixed user record editing with photos
• Fixed numeric field autocomplete behavior
• Fixed date picker behavior in boarding applications
• Fixed bill number ”/” character handling
• Fixed chargeback report column exports
• Fixed MFA setup token display
• Fixed vendor pay history filtering
• Fixed Add Vendor button functionality
• Fixed payment page saving/publishing
• Fixed org-level residuals exports formatting

API

New batch and bill filters

Added new filters for bill reporting:

• approvalUserId
• approvalUserEmail

Example:

• --url 'https://api-sandbox.payabli.com/api/Export/bills/csv/org/136?parameters=approvalUserId(eq)=1234'
• --url 'https://api-sandbox.payabli.com/api/Export/bills/csv/org/136?parameters=approvalUserEmail(eq)=admin@example.com'

Added new batch export and query filters:

• heldAmount
• releaseAmount
• feeBatchAmount
• netBatchAmount

Example: --url 'https://api-sandbox.payabli.com/api/Export/batches/csv/org/136?parameters=netBatchAmount(ge)=5000'

Business name in boarding application emails

When you get a new boarding application notification email, the merchant business name appears in the subject line.

ZIP fields support Canadian postal codes

Added support for six-character Canadian Postal codes across:

• Customer, vendor, and invoice records
• Boarding applications and templates
• Payment pages and virtual terminals

New columns in the batch report

Added new columns to batch reports:

• Service Fee
• Net Batch
• Held Amount
• Release Amount
• Gross Batch

Add headers to webhook notifications

You can now add custom web header parameters for your webhook notifications. Enhance security and make sure you only receive the webhooks you want by adding your own key:value pairs.

General UI enhancements

• Small spacing fixes for labels on the embedded components
• Added new icon in transaction reports to denote combined payment methods
• Made UI improvements for viewing reports on small screens

Bug fixes

Invoice related

• Fixed invoice created date changing on open/print
• Fixed custom fields and identifiers saving in Settings
• Fixed cash payment invoice status updates
• Fixed new customer creation from invoice records
• Fixed invoice sending from PartnerHub

Navigation and display

• Fixed Approvals report navigation
• Fixed receipt field customization display
• Fixed Failed filter in transactions report
• Fixed Virtual Terminal device loading
• Fixed user record editing with photos
• Fixed numeric field autocomplete behavior
• Fixed date picker behavior in boarding applications
• Fixed bill number ”/” character handling
• Fixed chargeback report column exports
• Fixed MFA setup token display
• Fixed vendor pay history filtering
• Fixed Add Vendor button functionality
• Fixed payment page saving/publishing
• Fixed org-level residuals exports formatting

API

New filters for batches and bills

Added new filters for bill reporting:

• approvalUserId
• approvalUserEmail

Example:

--url 'https://api-sandbox.payabli.com/api/Export/bills/csv/org/136?parameters=approvalUserId(eq)=1234'

--url 'https://api-sandbox.payabli.com/api/Export/bills/csv/org/136?parameters=approvalUserEmail(eq)=admin@example.com'

Added new batch export and query filters:

• heldAmount
• releaseAmount
• feeBatchAmount
• netBatchAmount

Example:

--url 'https://api-sandbox.payabli.com/api/Export/batches/csv/org/136?parameters=netBatchAmount(ge)=5000'

New features

Creator heads to beta

Creator, Payabli’s no-code component builder, enters beta in PartnerHub. Create branded components with simple configuration and auto-generated integration code. Currently supports:

• Reports components (fully embeddable)
• Pay In and Pay Out components (preview only)

ACH validation

Added real-time validation for ACH routing and account numbers for:

• Make a transaction
• Save a payment method (tokenize)
• Update a payment method

Enable by setting achValidation query parameter to true. Additional cost applies - contact Payabli for enablement.

Enhancements

Money in and out transaction reports UI enhancements

• Added new status and pay method badges and icons
• Updated View Check button visibility logic
• Improved Transaction report and Details screen consistency

Money out bills and approvals navigation

Added navigation to bill and approvals detail pages for easier movement between lists and individual records.

Find customer records faster

Added customer record links from:

• Transaction screens
• Autopay screens
• Chargebacks and ACH returns details
• Batches and funding details (PartnerHub only)

Bug fixes

UI and formatting

• Fixed PayMethod UI embedded component formatting with showPopoverError
• Removed SMS validation from business details phone field
• Fixed Send for Approval modal user display and email highlighting
• Fixed API Token screen pagination in PartnerHub
• Fixed credit card format validation in embedded components
• Fixed quantity changes for one-time items in Virtual Terminal
• Fixed MCC and paypoint search display
• Fixed credit card expiration date inputs

Transaction handling

• Fixed refund transaction processing
• Fixed invoice exports and downloads via API in sandbox