25 April 2023 - Release Notes

New Fund Via Tokenized Debit Card Endpoint
Update to ID Scan Endpoint

Overview

The following release notes contain updated versions of the following endpoints:

customer/v1/token/fund

If you have questions regarding the updates described in this document, please contact Avenu’s Support Department by email ([email protected]).

What's New?

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

Customer - Fund account via tokenized debit card

POST prefix/customer/v1/token/fund

We have created a new endpoint that allows Customers to fund their account with a tokenized debit card, and added a new "cardType" of "TOKEN" to be passed with this call.

Example Request

{
        "amount" : "",
        "currency" : "",
        "memo" : "",
        "cardType" : "",				// "TOKEN"
        "paymentToken" : "",				// Tokenized card information
        "cardholderFirstname" : "",
        "cardholderLastname" : "",
        "cardholderCompany" : "",
        "cardholderAddress1" : "", 
        "cardholderAddress2" : "",
        "cardholderCity" : "",
        "cardholderState" : "",
        "cardholderZip" : "",
        "cardholderCountry" : "",
        "cardholderPhone" : "",
        "cardholderEmail" : ""
}

Example Response

{
    "fund" : {
        "amount" : "",
        "currency" : "",
        "memo" : "",
        "cardType" : "",
        "paymentToken" : "",
        "cardholderFirstname" : "",
        "cardholderLastname" : "",
        "cardholderCompany" : "",
        "cardholderAddress1" : "",
        "cardholderAddress2" : "",
        "cardholderCity" : "",
        "cardholderState" : "",
        "cardholderZip" : "",
        "cardholderCountry" : "",
        "cardholderPhone" : "",
        "cardholderEmail" : ""
    },
    "transactionId" : "",
    "cardToken" : "",
    "status": "",
    "dateCreated": "",
    "dateUpdated": ""
}

Request Parameters

Parameter	Format	Required	Details
"amount"	Integer	Y	Funding amount in lowest currency e.g. cents
"currency"	String; Three-letter ISO currency code	Y	The transaction currency
"memo"	String	N	The transaction memo
"cardType"	enum<String>	Y	Card type
"paymentToken"	String	Y	Tokenized card information
"cardholderFirstname"	String	N	Cardholder first name
"cardholderLastname"	String	N	Cardholder last name
"cardholderCompany"	String	N	Cardholder's company
"cardholderAddress1"	String	N	Cardholder's billing address
"cardholderAddress2"	String	N	Cardholder's billing address, line 2
"cardholderCity"	String	N	Cardholder's billing city
"cardholderState"	String; Format: CC	N	Cardholder's billing state
"cardholderZip"	String	Y	Cardholder's billing zip code
"cardholderCountry"	String; Two-letter ISO 3166. Format: CC	N	Cardholder's billing country
"cardholderPhone"	String	N	Cardholder's billing phone number
"cardholderEmail"	String	N	Cardholder's billing email

Errors

code	Message
1001	"Missing required field"
1002	"Invalid data structure"
1003	"Invalid data"

Updates

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

Update -

POST /onboard/v1/customer/idScans

We've added some additional context in the response body when publishing ID Scans: "idScanResults", "idScanSummaryResult", and "idScanResultDetail"

Example Response

    {
        "idFront": "",    // MD5 hash of the Avenu customer's ID front image
        "idBack": "",     // MD5 hash of the Avenu customer's ID back image
        "idType": "",
        "idScanResult": "",
        "idScanSummaryResult": "",
        "idScanResultDetail": ""
    }

idScanResult(s)

idScanResult	Description
Result Id Scan Approved	Approved
Result Id Scan Not Approved	Not Approved

idScanSummaryResult(s)

idScanSummaryResult	Description
Expectid Scan Id Success	Success
Expectid Scan Id Failure	Failure

idScanResultDetail(s)

idScanResultDetail	Description
Result Document Verified	Indicates that the front/back of the document were able to be read, the template check passed, and the information on the front of the document matches the data from the barcode on the back.
Result OCR Completed	The data on the front of the document was successfully read.
Result Document Not Verified	The template checks against the document failed or the data from the back of the document does not match the data on the front of the document.
Result ID Not Readable	Indicates that the image submitted did not have the required quality needed to complete the verification process. The customer must re-take the images.