Skip to navigation

v1.0.24

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. Client constructors also now require their options argument. See November 5, 2026 and November 6, 2026 and November 16, 2026 and November 17, 2026 for more information.

Signature fields required on SubmitSigner

Payabli.SubmitSigner, the type of the submit request’s signer, makes signature (string) and signatureType (Payabli.SignatureType) required. 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
const signer: Payabli.SubmitSigner = {};
// After
const signer: Payabli.SubmitSigner = {
signature: "Jane Doe",
signatureType: Payabli.SignatureType.Type,
};

country required on BusinessAddressCreate

Payabli.BusinessAddressCreate no longer extends Payabli.BusinessAddress. It declares the same fields itself, with country (string) required.

// Before
const address: Payabli.BusinessAddressCreate = {};
// After
const address: Payabli.BusinessAddressCreate = { country: "US" };

Client options argument required

PayabliClient and every resource client, such as BoardingClient, no longer default their options argument to {}. If you called new PayabliClient() with no arguments and set your OAuth credentials in the OAUTH_CLIENT_ID and OAUTH_CLIENT_SECRET environment variables, pass an empty object.

// Before
const client = new PayabliClient();
// After
const client = new PayabliClient({});

New response fields

It also adds these response fields:

  • PeopleSearchResultResponse adds addresses (Payabli.PeopleSearchAddressResponse[]) and primaryAddress (Payabli.PeopleSearchAddressResponse | null). The new PeopleSearchAddressResponse has street, city, state, and zip (string | null).
  • PayabliCredentialsPascal adds active (boolean | null), clientId (string | null), and customerId (string | null).
  • BillDetailResponse, BillResponseData, and BillQueryRecord2 add StatusLabel (string | null).
  • TransactionOutQueryRecord, QueryPayoutTransactionRecordsItem, TransferOutDetailRecord, and PayoutSubscriptionQueryRecordPascal add StatusLabel (string | null). PayoutSubscriptionQueryRecord adds statusLabel (string | null).
  • TransferOutRecord adds transferStatusLabel (string | null).
  • QueryBatchesOutResponseRecordsItem adds BatchStatusLabel (string | null) and TransferDate (string).
  • VendorDataResponse and VendorQueryRecord add VendorStatusLabel (string | null).
  • Owners adds primaryOwner (boolean | null).