Changelog

This changelog provides an overview of the recent changes made to the Payabli APIs.
July 21, 2025

Changes for July 21, 2025

We’ve released several updates to the API and documentation. These changes are scheduled to go live in Production on July 21, 2025.

New: Process card payments in Canada

We’ve added support for processing card payments in Canadian dollars (CAD). This solution extends our core card-not-present processing capabilities to Canada-based customers while providing the same level of SaaS partnership support and revenue-sharing flexibility we offer today. Contact the Payabli team to learn more about using this functionality.

To process a card payment in CAD via the API, use the same API endpoints as for US processing. The only difference is that you must specify the CAD currency in your requests. See Process card payments in Canada for more information.

API changes

  • Removed method from the /Query/transferDetails endpoint response. This was a duplicate field, and Methodis the correct field to use.

  • Added Currency to the Credentials object in the GET /Paypoint/details endpoints. This field indicates the default currency for a paypoint, and returns either USD or CAD, depending on the paypoint’s settings.

  • We’ve added new fields to the boarding application data structures to capture sales representative information. These fields are:

    • RepCode: The code of the sales representative.
    • RepName: The name of the sales representative.
    • RepOffice: The office location of the sales representative.

    This change affects the following endpoints:

    • GET /Query/boarding/{orgId}: The response now includes the new sales rep fields, and the request now allows filtering by these fields.
    • PUT /Boarding/app/{appId} and POST /Boarding/app: The request now allows setting the rep fields.
    • All GET /Boarding/read/ endpoints: The responses now include the new rep fields.

New webhooks for payout subscriptions

We’ve added new webhook notifications for payout subscriptions:

Documentation updates

As part of an ongoing effort to better align the documentation with the API, we’ve updated the response schema for the GET /Paypoint details endpoints. These changes affect the documentation only The API itself hasn’t changed.

We aligned field casing and added missing fields in the Credentials object in response schema for GET /Paypoint/details endpoints. Note that this change doesn’t affect the Hosted Paypoint endpoints on the Paypoint route.

Old schema:

1  credentials:
2    properties:
3      accountId: optional<string>
4      cfeeFix: optional<double>
5      cfeeFloat: optional<double>
6      cfeeMax: optional<double>
7      cfeeMin: optional<double>
8      maxticket: optional<double>
9      minticket: optional<double>
10      mode: optional<integer>
11      referenceId: optional<long>
12      service: optional<string>

New schema:

1    Credentials
2      properties:
3      Service: optional<string>
4      Mode: optional<integer>
5      MinTicket: optional<double>
6      MaxTicket: optional<double>
7      CfeeFix: optional<double>
8      CfeeFloat: optional<double>
9      CfeeMin: optional<double>
10      CfeeMax: optional<double>
11      AccountId: optional<string>
12      ReferenceId: optional<long>
13      acceptSameDayACH: optional<boolean> ## Not in use yet
14      Currency: optional<string> ## Field added as part of the Canadian card processing update