Skip to navigation

Documentation changes for October 14, 2026

As part of an ongoing effort to better align the documentation with the API, we’ve corrected the payout subscription response schemas. These changes affect the documentation only. The API already returns this data.

Corrected casing in payout subscription responses

The get payout subscription response uses camelCase keys in the vendor, vendor.contacts, billData, and paymentData objects. The documentation showed PascalCase keys. For example, the API returns vendorNumber, not VendorNumber. We’ve corrected the schemas and the response example.

The list payout subscriptions endpoints use PascalCase keys, except in PaymentData, which mixes camelCase and PascalCase. PaymentData now has its own schema that matches the API. This affects the following endpoints:

Documented additional fields on payout subscription responses

Payout subscription responses now document these fields:

  • sameDayAch, doNotCreateBills, allowDuplicatedBills, autoConvertSameDayAch, and subscriptionType
  • walletType and payorSignature in paymentData
  • orderId, orderIdAlternative, orderDescription, paymentDescription, groupNumber, source, payabliTransId, unbundled, and surchargeFee in paymentData.paymentDetails
  • vendorPortal in vendor, in the get response only

These fields appear on Get payout subscription and on the list endpoints (by paypoint and by org). The list endpoints use PascalCase for the top-level fields, such as SameDayAch. The get response always returns some of these fields as null or 0, and their descriptions say so.

Documented additional vendor fields

Vendor records now document VendorPortal. Their stored payment methods now document IsDefault, and their billing data now documents country. This affects endpoints that return vendor records, including: