API changelog

As part of an ongoing effort to better align the documentation with the API, we’ve updated several Pay Out response schemas. These changes affect the documentation only, the API itself was already returning this data.

Corrected BatchId type on payout details

Corrected the type of the BatchId field from string to number on the GET /MoneyOut/details/:transId endpoint response. See Get payout details for more information.

Added SettlementStatusName and EntityId to payout details

Added documentation for two fields on the GET /MoneyOut/details/:transId endpoint response:

• SettlementStatusName (nullable string, the name of the settlement status)
• EntityId (nullable string, the entity’s ID in Payabli).

See Get payout details for more information.

Corrected Contacts type on vendor records

Corrected the type of the Contacts field on vendor records from a single object to an array of objects. This affects the following endpoints:

• Get vendor
• List vendors by paypoint
• List vendors by org
• Get payout subscription
• List payout subscriptions by paypoint
• List payout subscriptions by organization
• Get outbound transfer details