1 May 2024 - Release Notes

• Extending the Payments List endpoint to facilitate efficient pagination

Avenu API Release Notes 1.10.1

Overview

Extending the Payments List endpoint to facilitate efficient pagination

This enhancement entails extending the Payments List endpoint for a given customer by adding the total number of payments to the response in the totalPayments field.

What's New?

The following release notes detail the updates we have included in this release.

Extending the Payments List endpoint to facilitate efficient pagination

This will allow any front end application to implement an effective and intuitive pagination scheme for the list of payments that provides the entire breadth of ability to traverse through it. By having the totalPayments as a reference point, standard pagination mechanisms can now calculate the total number of pages as well as the ability to “jump” to the final or first page thereby implementing a “VCR buttons” like paradigm for pagination.

Example Response

[GET] customer/v1/payments

{
    "pagination": {
        "next": "customer/v1/payments?page=2"
    },
    "totalPayments": "45",
    "payments": [
        {
            "paymentType": "ACH",
            "recipientAccount": {
                "customerAccountNumber": null,
                "achAccountNumber": "706506853",
                "debitCardNumber": null,
                "debitCardExpiration": null,
                "debitCardCvv": null
            },
            "amount": "100",
            "currency": "USD",
            "memo": "Ach Debit request for 100",
            "paymentId": "a.0e3c0ad1-54df-457a-8ffa-12f858956822",
            "status": "SETTLED",
            "dateUpdated": "2024-04-30T04:00:01.645761Z"
        },...