Skip to navigation

v1.0.23

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, changes $signature from ?string to string and $signatureType from ?string to string (a SignatureType value). Its constructor now requires both keys. 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
$signer = new SubmitSigner([]);
// After
$signer = new SubmitSigner([
'signature' => 'Jane Doe',
'signatureType' => SignatureType::Type->value,
]);

country required on BusinessAddressCreate

BusinessAddressCreate no longer uses the BusinessAddress trait. It declares the same properties itself, and $country is now string instead of ?string, so its constructor requires the country key.

// Before
$address = new BusinessAddressCreate([]);
// After
$address = new BusinessAddressCreate(['country' => 'US']);

New response fields

It also adds these response fields:

  • PeopleSearchResultResponse adds $addresses (?array<PeopleSearchAddressResponse>) and $primaryAddress (?PeopleSearchAddressResponse). The new PeopleSearchAddressResponse has $street, $city, $state, and $zip (?string).
  • PayabliCredentialsPascal adds $active (?bool), $clientId (?string), and $customerId (?string).
  • BillDetailResponse, BillResponseData, and BillQueryRecord2 add $statusLabel (?string).
  • TransactionOutQueryRecord, QueryPayoutTransactionRecordsItem, TransferOutDetailRecord, PayoutSubscriptionQueryRecord, and PayoutSubscriptionQueryRecordPascal add $statusLabel (?string).
  • TransferOutRecord adds $transferStatusLabel (?string).
  • QueryBatchesOutResponseRecordsItem adds $batchStatusLabel (?string) and $transferDate (?DateTime).
  • VendorDataResponse and VendorQueryRecord add $vendorStatusLabel (?string).
  • Owners adds $primaryOwner (?bool).