2024 API and UI Changelog

Added the externalPaypointId field to the following endpoints:

• GET /Boarding/app/{appId}
• POST /Boarding/app
• PUT /Boarding/app/{appId}
• GET /Query/boarding/{orgId}

The externalPaypointId field is an optional unique identifier for a paypoint. It’s useful if you want to correlate a boarding application with a paypoint or merchant in your system.

We’ve added the DeviceID field to transaction detail and transaction query responses.

We’ve added the lastModified query parameter to the /Query/paypoints endpoint. You can use this parameter to filter paypoints by the date they were last modified.

We’ve released a new Payabli status page at https://status.payabli.com/. You can subscribe to updates from the page.

Improved error messages for managed payables

We’ve improved error messaging for MoneyOut/capture decline responses. When a capture of a managed payout is declined, you’ll now get a clear and actionable message in the resultText.

Changes to some query endpoints

The /Query/settlements endpoints now only return details for settled transactions. To get details about all batched transaction, regardless of settlement status, use the new batchDetails endpoints:

• By paypoint: /Query/batchDetails/{entry}
• By org: /Query/batchDetails/org/{orgId}

Added a language field to user objects to support future localization of PartnerHub and PayHub.

Embedded Components Playground

We’ve released the Embedded Components Playground, a new developer tool that lets you build and preview embedded components in your browser. Learn more in the guide, or try it out at https://playground.payabli.com.

Boarding

These changes impact the UI and boarding APIs.

• Improved boarding application field validations to support Canadian applicants.

API

These changes impact the APIs.

• Made enhancements to the TokenStorage/add endpoint and embedded components to improve the tokenization process for some cards. Before, tokenization sometimes failed for cards if they weren’t being tokenized as part of a transaction. We’ve added two new keys to the tokenization request body: fallbackAuth and fallbackAuthAmount to run an authorization on cards while tokenizing them. See the /TokenStorage/add reference, or the configuration reference section of the embedded components docs for more details.
• Improved tokenization error handling.

Payabli is excited to announce support for Apple Pay. We’ve made setup and management a breeze, so you can focus on making sales.

Activate Apple Pay

Before you can accept Apple Pay for transactions, you must set it up and activate it for your organization and paypoints. How you activate Apple Pay depends on whether you use the PartnerHub UI or the Payabli APIs.

• Activate Apple Pay (API)
• Activate Apple Pay (UI)

Accepting Apple Pay for transactions

You can use the Express Checkout embedded component, hosted payment pages, or payment links to accept Apple Pay for one-time transactions.

Via the embedded component

Use the Express Checkout embedded component for a secure low-code way to accept Apple Pay.

Via hosted payment pages

Configure your payment pages for a secure, no-code way to accept Apple Pay.

Via payment links

To accept Apple Pay from a payment link, set paymentMethods.methods.applePay to true when you create a payment link or update an existing payment link.

    // example truncated 

    "paymentMethods": {
      "methods": {
        "visa": true,
        "mastercard": true,
        "applePay": true
        "eCheck": true
      },
      "enabled": true

      // example truncated 

We’re happy to announce the release of an improved version of the engine that drives batches and funding. We will be migrating all paypoints to the new engine between July 23 and July 29.

The new batches and funding engine improves performance and observability, gives you the option to separate deposits from debits, like ACH returns and chargebacks, and gives you the option to choose between gross or net funding. If you choose gross funding, your debits can come from a bank account separate from your deposit account.

The existing batches and funding engine provides net funding, and paypoints won’t notice any changes to how funding works after the migration.

If you want to stay with the current funding model, you don’t need to take any action. If you want to move to a gross funding model or learn more about the new experience, reach out to the Payabli team.

Notifications

These changes impact notifications received via webhooks, SMS, and email.

• Fixed an issue that prevented notifications from being sent to multiple email addresses. Notifications are now sent to multiple email addresses as expected.
• Fixed an issue that prevented the activated merchant notification from being sent consistently. This notification now functions as expected.

Boarding

These changes impact boarding in the API and UI.

• Fixed an issue that prevented updates to boarding application status. Application status updates now function as expected.

Web app

These changes impact PartnerHub, PayHub, or both.

• Fixed a bug with payouts that caused incorrect record counts, totals, and total pages to be displayed. Record counts and totals now display as expected, and pagination works correctly.
• Fixed an issue that caused some card payment details to be incompletely displayed in the UI. Now, card details for a transaction display as expected.
• Fixed an issue with filters in the Transactions reports that prevented card transactions from being filtered correctly. The card filter now works as expected.

API

• Fixed a bug with the Query/payouts response that caused the summary to display incorrect record counts and totals. Record counts and totals now display as expected.
• Fixed an issue that caused some reverse requests to fail on the MoneyIn/getpaid endpoint. Reverse requests now function as expected.
• Fixed an issue that caused a 500 error to be triggered when certain lineItem fields are longer than allowed. Now, if a field is over, the API returns a 400 error with a clear error message.

Notifications

These changes impact notifications received via webhooks, SMS, and email.

We’ve added a new field to webhooks, email, and SMS notifications for new chargebacks and ACH returns. Now, when you have notifications enabled for new chargebacks or ACH returns, the notification includes the chargeback ID.

In the ReceivedChargeBack and ReceivedAchReturn webhook payloads, the ID is returned as chargebackID. In email and SMS notifications, the field appears as Chargeback ID.

Web app

These changes impact PartnerHub, PayHub, or both.

• Fixed a bug that prevented customers from entering alphanumeric ZIP codes on mobile devices. Now, alphanumeric ZIP codes are supported on mobile Virtual Terminals, payment pages, embedded components and more.
• Fixed a bug that prevented header from being displayed on some new invoices. Headers now display as expected.

API

• Improved handling for special characters in fields related to ACH. Before, non-standard characters would cause the error “Narrative value is invalid”. Now, Payabli transliterates these values to accepted characters.
• Fixed an issue with transfer notification emails that caused reason messages to be cut off. Now, reason messages display as expected.
• Fixed an issue with bulk payment files that caused all custom field names to be changed to lowercase. Now, Payabli preserves the original capitalization.
• Fixed validation on some endpoints that caused them to return a 500 response instead of a 200 response with success details or a 400 response with error details. Affected endpoints now function as expected.
• Fixed an issue with the MoneyOut/captureAll, MoneyOut/capture, and MoneyOut/cancelAll endpoints that prevented successful operations.

These changes affect the Payabli web apps and APIs.

• Fixed a bug with transfer notification emails that caused reason messages to be cut off. Now, reason messages display as expected.
• Fixed a bug with boarding applications that caused submitted applications to stay in the Not Submitted status. Application statuses now work as expected.

Web app

These changes impact PartnerHub, PayHub, or both.

• Fixed a bug with pagination in reporting components. Pagination now works as expected.
• Fixed a bug that caused the “Add Customer” window to close immediately when creating customer from an invoice. Adding a customer from an invoice now works as expected.
• Fixed a bug that prevented autopay exports from the web apps in sandbox. Autopay exports now work as expected in PartnerHub and PayHub.
• Fixed a bug that kept the “City” field from autopopulating while creating an organization. The field now populates as expected.
• Fixed a bug that caused boarding application dates to display inconsistently. Dates now work as expected.

API

Added a binData object to the API response for these endpoints:

• /TokenStorage/ GET
• /MoneyIn/details/ GET
• /Query/transactions/entry GET
• /Customer/customerId GET

This binData object displays important information about a payment card’s type and issuer, and includes the following fields:

• binMatchedLength: The number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table.
• binCardBrand: The card brand. For example, Visa, MasterCard, American Express, Discover
• binCardType: The type of card: Credit or Debit.
• binCardCategory: The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, and so on. The binCardCategory for prepaid cards is marked PREPAID. Examples:
  • GOLD
  • PREPAID BUSINESS
  • PLATINUM TRAVEL
  • PREPAID RELOADABLE
• binCardIssuer: The name of the financial institution that issued the card.
• binCardIssuerCountry: The issuing financial institution’s country name.
• binCardIssuerCountryCodeA2: The issuing financial institution’s two-character ISO country code. See this resource for a list of codes.
• binCardIssuerCountryNumber: The issuing financial institution’s ISO standard numeric country code. See this resource for a list of codes.

Web app

These changes impact PartnerHub, PayHub, or both.

Enhancements

• Added support for alphanumeric account holder and cardholder names in embedded components, hosted payment pages, and virtual terminal.
• Improved UI messages for Virtual Terminal to cloud device handoff and timeouts.
• Added “External Paypoint ID” and “DBA Name” columns to several reports in PartnerHub.
• Added “Deposit Account” and “Withdraw Account” columns to the Paypoint report in PartnerHub. These columns display masked account numbers for the accounts that Payabli uses for deposits and withdrawals for a paypoint.
• Made small UI enhancement to better display long email addresses on the password reset screen.
• Fixed an issue with the way long email addresses are displayed on the password reset screen.

Boarding

We recently announced two new API-only fields for boarding applications: resumable and recipientEmailNotification. Now, you can control these fields at the template level by editing the template’s details in PartnerHub.

API

These changes impact Payabli APIs.

Enhancements

• Added BatchNumber column to the Transfer details export.
• Removed the record limit for the Transfer details export. It was previously limited to 20 records.
• Improved bank account information handling. Now bank account columns appear in exports where applicable.
• Improved export and query performance for large or older transactions, batches, settlements, and chargebacks.

Bug Fixes

• Fixed a bug that caused columns in exports to break when certain fields contain commas in the value.

Boarding

We’ve added support for two new boarding application fields: resumable and recipientEmailNotification. These fields give you more control over your API-driven merchant boarding process.

You can use the resumable field to determine whether applicants can save and return to an application, and the recipientEmailNotification field to decide whether Payabli sends the applicant a boarding link.

Learn more about these fields:

• Send Prefilled Boarding Applications
• ApplicationData Object Model