Changelog
GuidesChangelog
Start typing to search…
Back to All
none

24 January 2024 - Release Notes

about 1 year ago by Mike Ireson
  • New client admin transfer refund endpoint
  • Fix for customer onboarding endpoint deviceFirstSeen and deviceLastSeen fields

Avenu API Release Notes 1.9.1

Overview

New client admin transfer refund endpoint

This new endpoint facilitates moving funds from the MainStreet Bank Remittance/Operating/Retail or any other transfer type that was configured in the client profile and associated with the original ACH transfer, to an Avenu customer account upon a request from the client.

Fix for customer onboarding endpoint deviceFirstSeen and deviceLastSeen fields

The update fixes an issue with these two fields not following the date format validation as prescribed in the documentation. Date format is now accepted as YYYY-MM-DD.

What's New?

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

New client admin transfer refund endpoint

POST {avenu_base_url}/client/v1/transferrefund

The new endpoint requires the original payment ID and original amount to be refunded back to the customer's account. The original payment must be in SETTLED status and can not have a previous refund.

Input Parameters

{
  "orignalPaymentId" : "", //Payment id of the original ACH Transfer now requested to refund the same amount back to Avenu customer account. The original ACH Transfer should be in SETTLED status in Avenu and there were no prior refund requests
  "customerAccount" : {
      "achAccountNumber": ""         // Customer account number(Open customer account and not closed or suspended account), routing number is hard coded
    },
  "clientAuthorized" : {
      "authorizedBy" : "",           // Name
      "authorizationTimestampGMT" : "", //date and timestamp in GMT
    },
  "amount": "",               // Amount needs to same as orignal tranaction amount, Amount will be postitive The payment amount in lowest currency denomination e.g. cents.
  "transferType": "",          // The transfer type needs to be exactly same as original transaction type
  "currency": "",             // Currency descriptor
  "memo": ""                 // A message to accompany the payment
}

Format

Data Field/Parameter

Format

Format Error Message

Other Requirements

Other Error Messages

originalPaymentID

alphanumeric & special characters “.” & “-” only

CA3107

Must match previous payment

Limit to one refund per transaction

original transaction must have status ‘SETTLED’

originalPaymentID does not match original ACH Transfer

Transaction already refunded

Invalid originalPaymentID - transaction must be Settled before processing a refund

achAccountNumber

numeric only, 5-17 digits

CA3107

Must be OPEN

Invalid achAccountNumber, include active accounts only

authorizedBy

A-Z, a-z, and [spaces] only, no numbers or special characters

limit to 100 characters

CA3107

authorizationTimestampGMT

ISO 8601 Date and Time format

CA3107

amount

Integer

limit to 6 digits

CA3107

Must match original payment

amount does not match original transaction

transferType

String

limit to 10 characters

CA3107

Must match original transferType

transferType does not match original transaction

Example Response

{
  "transfer": {
    "transferType": "REMITTANCE",
    "mainstreetBankAccount": {
      "transferAccountNumber": "",
      "achRoutingNumber": ""
    },
    "amount": xxx,
    "currency": "usd",
    "scheduledDate": "",
    "memo": "",
    "firstName" : "",
    "middleInitial" : "",
    "lastName" : "",
    "address" : "",
    "city" : "",
    "state" : "",
    "zipCode" : "",
    "country" : ""
  },
  "paymentId": "xxxx",    // UUID payment identifier
  "receiver": "",           // receiver(customer) account number
  "status": "",           // status of payment at end of transaction. See 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"
}