API changes for August 10, 2026

Logo fields and per-device metrics on device query records

The device query endpoints now return four new fields on each record:

FieldTypeDescription
paypointLogostringURL of the paypoint’s logo, or null when the paypoint has no logo.
parentOrgLogostringURL of the parent organization’s logo, or null when the organization has no logo.
transactionCountintegerTotal number of transactions processed by the device.
volumeProcessednumberTotal volume processed by the device, as the sum of net transaction amounts.

Payabli calculates transactionCount and volumeProcessed per device (by deviceId), not per paypoint. All four fields are also filterable through the parameters query string: use string operators for paypointLogo and parentOrgLogo, and numeric operators for transactionCount and volumeProcessed.

Affected endpoints

referenceId on payout authorization responses

Payout authorization responses return referenceId in the responseData object — the ID you pass to the capture endpoint to settle the transaction. A declined authorization returns null, because no transaction is created.

See Authorize payout for the full API reference.

allowedActions on payout query records

We’ve added an allowedActions array to each record returned by the payouts query endpoints. It lists the operations currently permitted for a payout, derived on the server from the payout’s status, so you no longer have to hardcode status-to-action logic on the client.

The field is always present. Possible values are capture, cancel, and reissue, matching the corresponding MoneyOut endpoint verbs. It’s empty for terminal statuses such as paid or canceled. Read allowedActions directly rather than inferring available actions from PaymentStatus.

1{"allowedActions": ["capture", "cancel"]}

Affected endpoints