Skip to navigation

v1.0.21

This release includes breaking changes. It requires the signer’s signature fields when you submit an application and country on business addresses you create, and adds status labels to Pay Out responses, addresses to people search results, and gateway fields to paypoint credentials. See November 5, 2026 and November 6, 2026 and November 16, 2026 and November 17, 2026 for more information.

Signature fields required on SubmitSigner

SubmitSigner, the type of the submit request’s signer, makes signature (str) and signature_type (SignatureType) required. The API now requires both to submit an application, and signed_document_reference no longer replaces them. If you submitted applications with only signed_document_reference, set both signature fields too. Creating a SubmitSigner without them raises a validation error.

# Before
signer = SubmitSigner()
# After
signer = SubmitSigner(signature="Jane Doe", signature_type="type")

country required on BusinessAddressCreate

BusinessAddressCreate no longer subclasses BusinessAddress, so isinstance(address, BusinessAddress) is now False. It declares the same fields itself, with country (str) required.

# Before
address = BusinessAddressCreate()
# After
address = BusinessAddressCreate(country="US")

New response fields

It also adds these response fields:

  • PeopleSearchResultResponse adds addresses (Optional[List[PeopleSearchAddressResponse]]) and primary_address (Optional[PeopleSearchAddressResponse]). The new PeopleSearchAddressResponse has street, city, state, and zip (Optional[str]).
  • PayabliCredentialsPascal adds active (Optional[bool]), client_id (Optional[str]), and customer_id (Optional[str]).
  • BillDetailResponse, BillResponseData, and BillQueryRecord2 add status_label (Optional[str]).
  • TransactionOutQueryRecord, QueryPayoutTransactionRecordsItem, TransferOutDetailRecord, PayoutSubscriptionQueryRecord, and PayoutSubscriptionQueryRecordPascal add status_label (Optional[str]).
  • TransferOutRecord adds transfer_status_label (Optional[str]).
  • QueryBatchesOutResponseRecordsItem adds batch_status_label (Optional[str]) and transfer_date (Optional[datetime]).
  • VendorDataResponse and VendorQueryRecord add vendor_status_label (Optional[str]).
  • Owners adds primary_owner (Optional[bool]).