Skip to navigation

v1.0.20

This release includes breaking changes. It corrects the organization details types to match the API, renames the ticket amount fields 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.get_basic_organization and organization.get_basic_organization_by_id now return GetBasicOrganizationResponse instead of OrganizationQueryRecord. The organization details are in response_data, alongside is_success and response_text.

# Before
org: OrganizationQueryRecord = client.organization.get_basic_organization("my-org")
# After
basic: GetBasicOrganizationResponse = client.organization.get_basic_organization("my-org")
org: typing.Optional[OrganizationQueryRecord] = basic.response_data

Organization details types match the API

OrganizationQueryRecord changes these field types:

  • billing_info is now InstrumentResponse instead of Instrument. InstrumentResponse has ach_account, ach_routing, billing_address, billing_city, billing_country, billing_state, and billing_zip (typing.Optional[str]).
  • contacts is now typing.List[ContactsResponse] instead of ContactsField. ContactsResponse has contact_name, contact_email, contact_title, and contact_phone.
  • org_logo is now str, the logo’s URL, instead of FileContent.

It also adds org_favicon (typing.Optional[str]), the URL of the organization’s favicon. The field names are unchanged, but their aliases now match the PascalCase names the API returns, such as OrgId and BillingInfo.

Ticket amount fields renamed

PayabliCredentialsPascal renames max_ticket to maxticket and min_ticket to minticket.

# Before
print(credentials.max_ticket, credentials.min_ticket)
# After
print(credentials.maxticket, credentials.minticket)

Organizations client (beta)

The client adds organizations, with list_organizations, create_organization, get_organization, and update_organization. create_organization takes request: CreateOrganizationOrganizationsRequest, which is CreateOrganizationWithInlineBusiness, CreateOrganizationWithBusinessReference, or CreateOrganizationAllFields. The methods return envelope types, such as PaypointDetailEnvelope. These endpoints only accept OAuth. See OAuth authentication.

detail: PaypointDetailEnvelope = client.organizations.get_organization("org-reference")

Other changes

  • MethodsListOut adds rtp and wire (typing.Optional[bool]).
  • PaypointSummaryResponse adds external_id (typing.Optional[str]).
  • paypoints.list_paypoints now raises BadRequestError for HTTP 400.