ProcessPay Explained: API vs UI for Payment Processing

Let’s talk about ProcessPay. What is it? It’s really just a term that describes how payments are started and completed, whether that’s automatically through APIs or manually through a user interface in a payroll or finance system.

So, ProcessPay can mean automating payments using APIs or handling payroll manually. This article will cover both. We’ll look at the technical side of automating payments with APIs and also the practical steps of manual payroll processing.

We’ll explore Tipalti’s ProcessPayments API function and also a payroll processing pay group form to give you a complete picture of ProcessPay.

Automating Payments with the Tipalti `ProcessPayments` API

One of the most powerful tools Tipalti offers is the `ProcessPayments` API, which allows you to automate and streamline your payment processes. Let’s break down how it works.

Understanding the `ProcessPayments` Function

This API function is all about batch processing payment orders, making it efficient to handle multiple payments at once. Keep in mind, though, that you’re limited to a maximum of 250 payment orders per request.

Key Parameters and Data Structure

The `RefCode` is crucial for preventing duplicate payments. If you resubmit a request with the same `RefCode`, you could end up paying twice! You’ll also need to understand the input parameters like `payerName`, `paymentGroupTitle`, and the structure of `tipaltiPaymentsOrders` and its components like `TipaltiPaymentOrderItem`, `Idap`, `Amount`, and `CustomFields`. Make sure you stick to the specified data types and length restrictions to avoid errors.

On the output side, you’ll get parameters like `errorMessage`, `errorCode`, `linesResults`, `ExpandedLineResult`, `paymentOrderStatus`, `accountType`, `accountCurrency`, `fundsRequired`, `tipaltiSummaryAmounts`, `totalAmount`, and `immediateAmount`. Understanding these outputs is key for accurately tracking and reconciling your payments.

Error Handling and Validation

Pay close attention to the error codes and messages returned by the API. Implement solid error handling in your code to gracefully manage these responses. Also, make sure you adhere to all the validation rules. Following these rules is essential for successfully processing your payments.

Payroll Processing with Pay Groups: A UI-Driven Approach

ProcessPay offers a user-friendly way to handle payroll for specific groups of employees. This is especially useful if you need to run payroll separately for different types of employees, like sales staff or hourly workers.

Introducing the Payroll Process Pay Group Form

The Payroll Process Pay Group form lets you manage payroll through an easy-to-use interface.

Step-by-Step Payroll Processing

Here’s how to process payroll using pay groups:

  1. Select the right pay group, bank account, pay period, and pay date. It’s important to choose the correct settings for each payroll run.
  2. Choose the employees you want to pay. You can select individuals or use the “Select All” and “Deselect All” buttons to quickly add or remove employees from the list.
  3. Review the payroll details for each employee. The form shows important information like hours worked and pay amounts.

Key Fields and Buttons

These fields are important for accurate payroll processing:

  • Period Begin/End Date
  • Pay Date
  • Bank Account
  • Employee
  • Time Sheet
  • Pay Frequency
  • Last Paid
  • Account ID

The “Pay” checkbox starts the payroll process for the selected employees, and the “Create Paychecks” button finishes the process and generates the paychecks.

The Bottom Line

ProcessPay offers two routes for managing payments: the automated ProcessPayments API and the more hands-on payroll processing forms. Understanding both is essential for comprehensive payment management.

Depending on your organization’s specific needs, you might use one or both methods to ensure that payments are processed correctly.

Efficient and accurate payment processing is key to smooth financial operations and a happy, productive workforce.