Changelog
GuidesChangelog
Start typing to search…
Back to All

5 October 2023 - Release Notes

over 1 year ago by Mike Ireson
  • Enhanced error code handling fortransfer endpoint
  • Fix for payments endpoint to return ACH_TRANSFER on applicable payment types for recent payments.
  • Additional payment details added in transfer endpoint response body

Avenu API Release Notes 1.8.1

Overview

Enhanced error code handling for transfer endpoint

More detailed error code responses on the transfer endpoint will help better understand which fields are causing errors and why from the response.

Fix payments endpoint to return ACH_TRANSFER on applicable payment types for recent payments

As part of the rollout for the new transfer endpoint we've updated the "Get Recent Payments" payments endpoint to reflect the new payment type appropriately.

Additional payment details added in transfer endpoint response body

As part of the rollout for the new transfer endpoint we've added additional payment details to the response body.

What's New?

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

Enhanced error code handling for transfer endpoint

POST {prefix}/client/v1/transfer

We have provided a more detailed error code responses on the transfer endpoint that will help better understand which fields are causing errors and why from the response.

CategoryResponse CodeError Message
Format (F)CA3015Invalid Format
Size (S)CA3015Invalid Length
Required (R)CA3000Missing Required Field

Example Response

{
  "errorCodeMessageList": [
      {
          "code": "CA300-1R", // 1 refers to first field, R refers to Required
          "message": "Missing Required Field"
      },
      {
          "code": "CA3105-2F", // 2 refers to the second field, F refers to Format
          "message": "Invalid Format"
      },
      {
          "code": "CA3105-7S", // 7 refers to the seventh field, S refers to Size
          "message": "Invalid Length"
      }
  ]
}

Additional payment details added in transfer endpoint

We continue to improve the transfer endpoint and have added additional payment details in the response body.

Example Response

{
      "transfer": {
        "transferType": "REMITTANCE", // example from the first column in the account array
        "mainstreetBankAccount": {
          "transferAccountNumber": "",     
          "achRoutingNumber": ""
        },
        "amount": xxx,
        "currency": "usd",
        "scheduledDate": "",
        "numberOfPayments": "",
        "paymentsInterval": "",
        "memo": "",
        "firstName" : "",
        "middleInitial" : "",
        "lastName" : "",
        "address" : "",
        "city" : "",
        "state" : "",
        "zipCode" : "",
        "country" : "",
        "authorizedBy" : "John Smith",   // Name
        "authorizationTimestampGMT" : "08/04/2023" //Date and timestamp
      },
      "paymentId": "xxxx",    // UUID payment identifier
      "sender": "",           // sender account number
      "status": "",           // status of payment at end of transaction. See link below.
      "dateCreated": "",      // Transaction processed date in format ISO 8601 YYYY-MM-DD. See link below
      "dateUpdated": "",      // Date of last status update in format ISO 8601 YYYY-MM-DD
      "publicTraceNumber": "xxxxxxxx"
    }