Skip to navigation
Server SDKsTypeScript SDK

Changelog

October 27, 2026

v1.0.23

This release includes breaking changes. It corrects the organization details types to match the API, renames the ticket amount properties on paypoint credentials, and adds an organizations client for the intelligent boarding API (beta). See October 20, 2026 and October 22, 2026 and October 27, 2026 for more information.

Basic organization details return a response envelope

organization.getBasicOrganization and organization.getBasicOrganizationById now return Payabli.GetBasicOrganizationResponse instead of Payabli.OrganizationQueryRecord. The organization details are in responseData, alongside isSuccess and responseText.

// Before
const org: Payabli.OrganizationQueryRecord = await client.organization.getBasicOrganization("my-org");
// After
const basic: Payabli.GetBasicOrganizationResponse = await client.organization.getBasicOrganization("my-org");
const org: Payabli.OrganizationQueryRecord | undefined = basic.responseData;

Organization details properties use PascalCase

Payabli.OrganizationQueryRecord properties now use the PascalCase names the API returns, so code that reads the old names no longer type-checks.

  • billingInfo → BillingInfo
  • contacts → Contacts
  • hasBilling → HasBilling
  • hasResidual → HasResidual
  • orgAddress → OrgAddress
  • orgCity → OrgCity
  • orgCountry → OrgCountry
  • orgEntryName → OrgEntryName
  • orgId → OrgId
  • orgLogo → OrgLogo
  • orgName → OrgName
  • orgParentId → OrgParentId
  • orgParentName → OrgParentName
  • orgState → OrgState
  • orgTimezone → OrgTimezone
  • orgType → OrgType
  • orgWebsite → OrgWebsite
  • orgZip → OrgZip
  • replyToEmail → ReplyToEmail
  • services → Services

Some properties also change type:

  • BillingInfo is now Payabli.InstrumentResponse instead of Payabli.Instrument. InstrumentResponse has achAccount, achRouting, billingAddress, billingCity, billingCountry, billingState, and billingZip (string | null).
  • Contacts is now Payabli.ContactsResponse[] instead of Payabli.ContactsField. ContactsResponse has ContactName, ContactEmail, ContactTitle, and ContactPhone.
  • OrgLogo is now string, the logo’s URL, instead of Payabli.FileContent.

OrganizationQueryRecord also adds OrgFavicon (string), the URL of the organization’s favicon.

Ticket amount properties renamed

Payabli.PayabliCredentialsPascal renames MaxTicket to Maxticket and MinTicket to Minticket.

// Before
const credentials: Payabli.PayabliCredentialsPascal = { MaxTicket: 1000, MinTicket: 1 };
// After
const credentials: Payabli.PayabliCredentialsPascal = { Maxticket: 1000, Minticket: 1 };

Organizations client (beta)

PayabliClient adds the organizations client, with listOrganizations, createOrganization, getOrganization, and updateOrganization. createOrganization takes Payabli.CreateOrganizationOrganizationsRequest, which is Payabli.CreateOrganizationWithInlineBusiness, Payabli.CreateOrganizationWithBusinessReference, or Payabli.CreateOrganizationAllFields. The methods return envelope types, such as Payabli.PaypointDetailEnvelope. package.json adds the ./organizations export path.

These endpoints only accept OAuth. Set bearerAuth with your OAuth clientId and clientSecret when you create the client. See OAuth authentication.

const detail: Payabli.PaypointDetailEnvelope = await client.organizations.getOrganization("org-reference");

Other changes

  • Payabli.MethodsListOut adds rtp and wire (boolean).
  • Payabli.PaypointSummaryResponse adds externalId (string).
  • paypoints.listPaypoints now throws Payabli.BadRequestError for HTTP 400.