Skip to navigation

v1.0.21

This release adds clients for the intelligent boarding API (beta) and marks the legacy boarding methods as deprecated. See October 19, 2026 for more information.

Intelligent boarding clients (beta)

PayabliClient adds the $businesses, $people, $paypoints, $paymentMethods, $boardingTemplates, and $applications clients. Their methods return envelope types, such as BusinessDetailEnvelope.

These endpoints only accept OAuth. Pass your OAuth clientId and clientSecret when you create the client. See OAuth authentication and Manage API credentials.

$client = new PayabliClient(clientId: 'CLIENT_ID', clientSecret: 'CLIENT_SECRET');
$business = $client->businesses->getBusiness('BUSINESS_REFERENCE');

Legacy boarding methods are deprecated

Legacy boarding will be sunset in Q2 2027. Every method on $boarding and $templates now has a deprecation warning in its documentation. The applications export method on $export was already deprecated. The methods don’t have a @deprecated tag, so your IDE doesn’t flag them.

Case management bank account services

The new CaseManagementMoneyInService and CaseManagementMoneyOutService enumerations list the values for BankAccountServices. They have the same values as MoneyInService and MoneyOutService, so existing code still works.

v1.0.20

This release adds methods to get the next check number and cancel ghost cards, a check number on reissued payouts, invoice data on subscription updates, a 1099 flag on vendors, every payout that paid a bill, and card-present device details. See October 19, 2026 for more information.

New methods

  • $client->moneyOut->getNextCheckNumber(int $paypointId, string $accountId) returns ?NextCheckNumberResponse, whose $checkNumber is a string.
  • $client->ghostCard->deleteGhostCard(string $cardToken) returns ?DeleteGhostCardResponse. Its $responseData has $deleteType and $cardToken (?string).
$next = $client->moneyOut->getNextCheckNumber(285, 'ACCOUNT_ID');
$deleted = $client->ghostCard->deleteGhostCard('CARD_TOKEN');

Request changes

  • ReissueOutRequest adds $checkNumber (?string).
  • RequestUpdateSchedule, the request for $client->subscription->updateSubscription, adds $invoiceData (?BillData).
  • VendorData adds $issue1099 (?bool).

Vendor 1099 flag

VendorQueryRecord, VendorDataResponse, TransferOutDetailVendor, and PayoutSubscriptionVendor add the required property $issue1099 (bool). AssociatedVendor, VCardGetResponseAssociatedVendor, VendorOutData, and GetMethodResponseResponseDataVendorsItem add $issue1099 (?bool).

Payouts that paid a bill

BillResponseData and BillQueryRecord2 add $transactions (?array<BillTransactionReference>). Each BillTransactionReference has $idOut (int) and $paymentId (?string).

Card-present device details

  • TransactionQueryRecords and TransactionQueryRecordsCustomer add $deviceEntryMode (?string), $emvAuthData (?EmvAuthData, with $requestEmvData and $responseEmvData), and $deviceData (?QueryDeviceData).
  • DeviceQueryRecord adds the required property $operationalStatus (string), which holds 'online', 'busy', or 'offline'. These are the values of the new DeviceQueryRecordOperationalStatus enum, so compare against a case’s value, such as DeviceQueryRecordOperationalStatus::Online->value. It also adds $appVersion and $osVersion (?string).

Code that creates these records without the new required properties, such as tests and mocks, must set them.