Skip to navigation

v1.0.25

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.builder() is now a staged builder: call signature(String) and then signatureType(SignatureType) before any other setter or build(). getSignature() now returns String instead of Optional<String>, and getSignatureType() returns SignatureType instead of Optional<SignatureType>. The API now requires both to submit an application, and signedDocumentReference no longer replaces them. If you submitted applications with only signedDocumentReference, set both signature fields too.

// Before
SubmitSigner signer = SubmitSigner.builder().build();
// After
SubmitSigner signer = SubmitSigner.builder()
.signature("Jane Doe")
.signatureType(SignatureType.TYPE)
.build();

country required on BusinessAddressCreate

BusinessAddressCreate.builder() now starts with country(String), and getCountry() returns String instead of Optional<String>. The IBusinessAddress interface is removed, so BusinessAddress and BusinessAddressCreate no longer implement a shared interface.

// Before
BusinessAddressCreate address = BusinessAddressCreate.builder().build();
// After
BusinessAddressCreate address = BusinessAddressCreate.builder().country("US").build();

New response fields

It also adds these response fields, each with a builder setter:

  • PeopleSearchResultResponse adds getAddresses() (Optional<List<PeopleSearchAddressResponse>>) and getPrimaryAddress() (Optional<PeopleSearchAddressResponse>). The new PeopleSearchAddressResponse has getStreet(), getCity(), getState(), and getZip() (Optional<String>).
  • PayabliCredentialsPascal adds getActive() (Optional<Boolean>), getClientId() (Optional<String>), and getCustomerId() (Optional<String>).
  • BillDetailResponse, BillResponseData, and BillQueryRecord2 add getStatusLabel() (Optional<String>).
  • TransactionOutQueryRecord, QueryPayoutTransactionRecordsItem, TransferOutDetailRecord, PayoutSubscriptionQueryRecord, and PayoutSubscriptionQueryRecordPascal add getStatusLabel() (Optional<String>).
  • TransferOutRecord adds getTransferStatusLabel() (Optional<String>).
  • QueryBatchesOutResponseRecordsItem adds getBatchStatusLabel() (Optional<String>) and getTransferDate() (Optional<OffsetDateTime>).
  • VendorDataResponse and VendorQueryRecord add getVendorStatusLabel() (Optional<String>).
  • Owners adds getPrimaryOwner() (Optional<Boolean>).