Changelog

New endpoint for downloading chargeback attachments

We added the GET /ChargeBacks/getChargebackAttachments/{Id}/{fileName} endpoint. This endpoint allows you to download chargeback attachments, such as PDFs or images, associated with a chargeback record. The Id parameter is the ID of the chargeback record, and the fileName parameter is the name of the file you want to download.

New query parameters for export endpoints

• Added the limitRecord query parameter to all export endpoints. This parameter limits the number of records to return for the query. The maximum is 30,000 records. When you don’t include this parameter, the API returns up to 25,000 records.

• Added the fromRecord query parameter to all export endpoints. This parameter specifies the record number to start the export from. The default is 0.

You can use these query parameters together to paginate through large exports. For example, to get the first 10,000 records of an export, you would use limitRecord=10000&fromRecord=0. To get the next 10,000 records, you would use limitRecord=10000&fromRecord=10000.

New API fields

We’ve added several new fields to several endpoints.

• Added the AchSecCode field to responses for the GET Query/transactions and GET MoneyIn/details/{transId} operations. SEC code is a three letter code that describes how an ACH payment was authorized. The Query/transactions endpoints also support filtering by AchSecCode and supports these operators: ct, nct, in, nin, eq, and ne.
• Added a field that specifies what whether an accountholder is a person or a business to several request and response bodies. The field supports these values: personal and business.
• Added the achHolderType field to the request bodies for the POST TokenStorage/add, POST Subscription/add, POST TokenStorage/update, and POST MoneyIn/getpaid endpoints.
• Added AchHolderType field to the responses for the GET TokenStorage/{methodId}, GET Query/transactions and GET MoneyIn/details/{transId} endpoints.

Improved error message for transaction amount limits

We updated an error message to make it easier to understand. An error for a transaction amount outside of the maximum and minimum limits of a paypoint will now display the message:

“Transaction amount is outside the minimum and maximum limit of the paypoint.”

instead of:

“No tier is available for the amount, mode 0 or 2.”

API updates

We’ve released several enhancements and bug fixes to our API. Here are the highlights:

Pay In

• Added the ability to skip a subscription payment by setting totalAmount to zero. See Pause a subscription or skip a payment for more details.

• Added the expectedProcessingDateTime field to the responses for these endpoints:

  • GET /MoneyIn/refund/{transId}/{amount}
  • GET /MoneyIn/reverse/{transId}/{amount}
  • POST /MoneyIn/refund/{transId}

  When a paypoint has Enhanced Refund Flow enabled, the expectedProcessingDateTime field shows the date and time that a queued refund is expected to be processed.

Pay Out

Added the parentOrgId filter with (eq, neq, in, nin) operators to these endpoints:

• Query/batchesOut/{entry}
• Query/batchesOut/org/{orgId}
• Query/payouts/{entry}/{orgId}
• Query/payouts/org/{orgId}
• Query/bills/{entry}
• Query/bills/{entry}/org/{orgId}
• Query/vendors/{entry}
• Query/vendors/org/{orgId}

Pay Ops

• All instances of EIN values returned in API responses are now masked.
• Added a UpdatedMerchant webhook notification for paypoint updates. You can now get a notification when a paypoint’s address, banking information, or funding configuration is updated. See Webhook Notification Response Reference for the webhook payload.
• Added the ReplyBy field to responses from the Query/chargebacks endpoint. The ReplyBy field is the deadline by which a merchant must respond to a dispute. By default, this field is exactly 10 days after the CreatedAt timestamp, in UTC.
• Added the replyDate filter to the Query/chargebacks endpoint which allows filtering disputes by deadline. replyDate has the following conditions: (gt, ge, lt, le, eq, ne). See the Filters and Conditions Reference for more information.

API updates

We’ve released several enhancements and bug fixes to our API. Here are the highlights:

Pay In

• Added new notifications for TransferAdjusted, TransferReadyforRetry, TransferResolved events. See Notifications and Reports Overview for more information.
• Added the settings objects for configuring Apple Pay for payment pages. Before, you had to use the AdditionalData object to configure Apple Pay. See Configure the Apple Pay Button for more information.

Pay Out

• Implemented masking for the EIN field in the response for the GET /Bill/{idBill} endpoint.
• Added the Gateway field in the response for the /MoneyOut/details/{transId} and /Query/payouts/{entry} endpoints.

Pay Ops

Added four new export endpoints:

• /Export/batchDetails/{format}/{entry}
• /Export/batchDetails/{format}/org/{orgId}
• /Export/batchesOut/{format}/{entry}
• /Export/batchesOut/{format}/org/{orgId}

Added a new query parameter columnsExport to export endpoints, including exports for:

• Transactions
• Batches
• Subscriptions
• Settlements
• Transfers
• Chargebacks
• Customers
• Organizations
• Boarding
• Paypoints
• Invoices
• Vendors
• Bills
• Payouts

This new parameter lets you define a custom column mapping for an export. Documentation for the parameter is available in each endpoint’s API reference.

Custom batch times and enhanced refund flow

We’re excited to changes that allow you to close Pay In batches when it makes sense for your merchants. With Custom Batch Times, you can choose any hour of the day as your preferred batch cutoff time instead of using the default of 5 PM Eastern Time.

We’ve also released the Enhanced Refund Flow. This feature provides a frustration-free experience for processing card refunds, ensuring that refunds are processed at the optimal time to avoid issues with the backend processor.

To opt in to Custom Batch Times or the Enhanced Refund Flow, contact the Payabli team.

Added externalPaypointId to boarding application endpoints

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.

DeviceID added to API responses

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

New query parameter

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.