Customers can dispute a transaction utilizing the create dispute endpoint. This is used for fraudulent and/or unauthorized charges that may appear on the customer's ledger. Creating a dispute does not guarantee a resolution in the customer's favor. The status will be pending until the dispute case is handled in the case management system by administration.
Device identification is optional, but it is passed to Hummingbird for help with case management (refunds, fraud, etc.).
URL
{{avenu_base_url}}/customer/v1/dispute
JSON
{
"transactionID": "",
"disputeReason": "",
"disputeType": "",
"declarationAcknowledged": true,
"deviceIdentity": {
"deviceId": "",
"deviceType": "",
"deviceName": "",
"deviceOperatingSystem": "",
"deviceIPAddress": "",
"deviceLocation": "",
"deviceLongitude": "",
"deviceLatitude": "",
"deviceUser": "",
"deviceIMEINumber" : "",
"deviceTorEnabled" : "",
"deviceFirstSeen" : "",
"deviceLastSeen" : ""
}
}
Parameter Format Required Details "transactionID" String Y The transaction ID to dispute. "disputeReason" String N The reason for the dispute (free text). "disputeType" String N The type of the dispute - default: UNAUTHORIZED "declarationAcknowledged" Boolean Y This value must always be "true" - otherwise, return Error Code 1001. "deviceId" String N The user's unique device identifier. "deviceType" String N The type of the user's device "deviceName" String N The name given to the user's device. "deviceOperatingSystem" String N The OS of the user's device. "deviceIPAddress" String N Current IP Address for the device. "deviceLocation" String N Current location for the device. "deviceLongitude" String N Device's location longitude. "deviceLatitude" String N Device's location latitude. "deviceUser" String N The name of the user of the device. "deviceIMEINumber" String N Mobile device unique equipment identifier. "deviceTorEnabled" Boolean N Device is/is not using Tor browser. "deviceFirstSeen" String; ISO 8601 YYYY-MM-DD N Date/Time the device was first used to access Avenu. "deviceLastSeen" String; ISO 8601 YYYY-MM-DD N Date/Time the device was last used to access Avenu.
JSON
{
"disputeID": "",
"dateUpdated": "",
"memo": "",
"amount": "",
"currencyType": "",
"status": ""
}
Element Details disputeID Unique ID to track this dispute case dateUpdated Dispute updated date in format ISO 8601 YYYY-MM-DD memo Memo associated with the dispute amount Dispute amount currencyType Dispute currency status Dispute status
code Message 1001 "Missing required field" 1002 "Error - Invalid data structure" 1003 "Error - Invalid data" 1010 "Error - Transaction Not Allowed" 1012 "Error - Call Issuer"
The current status of a dispute can be retrieved by passing the unique disputeID
as a parameter to the dispute endpoint.
URL
{{avenu_base_url}}/customer/v1/dispute/{{disputeID}}
Parameter Format Required "disputeID" UUID String Y
JSON
{
"disputeID": "",
"dateUpdated": "",
"memo": "",
"amount": xxx,
"currencyType": "",
"status": ""
}
Element Details disputeID Unique ID to track this dispute case dateUpdated Dispute updated date in format ISO 8601 YYYY-MM-DD memo Memo associated with the dispute amount Dispute amount currencyType Dispute currency status Dispute status