Changelog
Behavioural and contract changes to the API that integrators need to act on. Newest first.
Only changes visible to an API consumer appear here - a field whose value or meaning changes, a new field worth consuming, a change in who pays what. Internal refactors do not. Additive fields are listed so you know they exist; breaking entries state exactly what to change.
Read this before each deploy.
No changes yet
PayDirect is on its initial release, so there is nothing here to act on. Every behaviour described in these guides is how the API has always worked - there is no older contract to migrate from.
The first entry will appear the first time something changes that your integration can observe.
Staying current
- Check this page before each deploy, or subscribe your engineering channel to release notifications.
- Additive fields can appear at any time. Parse JSON permissively - ignore fields you do not recognise rather than rejecting the payload. New fields are not announced as breaking changes.
- The same applies to webhook event types. Acknowledge an unfamiliar
eventwith a2xxand ignore it, rather than erroring. See Retries and delivery. - Anything that would break a working integration gets its own entry here, stating exactly what to change.
Next
Support - what to send us when something is wrong.