TL;DR - Added HATEOS / HAL style _links field to all responses to aid data reconciliation.

Summary

This is a feature release for the Transactional Data API which affects all endpoints in the API, adding a _links field to the model of each response object which helps with reconciliation of related records across authorisations, transactions, fundings and funding details.

See the following example for an authorisation

{
  "id": "12345",
  "created": "2023-01-01T15:44:59Z",
  "status": "APPROVED",
  // ... other fields
  "_links": {
    "transactions": {
      "href": "/transactions?postedAfter=2023-01-01&postedBefore=2023-01-02&orderId=123456"
    }
  }
}

Features

Added field _links to help with reconciliation between related objects, this replaces the need for documentation such as our reconciliation diagram.

🚧

Note:

This feature relies on the underlying data and specific products used for authorisation, clearing and funding processes. Depending on your setup, not all links may be available.

To benefit from this feature, you can use links to make API calls for related objects. For example, after retrieving an authorisation record as in the example above, you would be able to call:

GET /transactions?postedAfter=2023-01-01&postedBefore=2023-01-02&orderId=123456

To search for a matching transaction. From there you can link back to authorisation(s) or to fundings.

This is useful for building UIs that allow users to traverse through related items, or automating your data collection and reconciliation across the lifecycle of a payment.

Improvements

N/A

Misc Notes

N/A