customer/v1/dispute

[POST] customer/v1/dispute

Create a dispute

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.

Please note: Customers cannot dispute a debit transfer. Only ACH transfers may be disputed.

Device identification is optional, but it is passed to Hummingbird for help with case management (refunds, fraud, etc.).

Example [POST] Request

{{avenu_base_url}}/customer/v1/dispute
 {
    "transactionID": "",
    "disputeReason": "",
    "disputeType": "",
    "declarationAcknowledged": true,
    "deviceIdentity": {
        "deviceId": "",
        "deviceType": "",
        "deviceName": "",
        "deviceOperatingSystem": "",
        "deviceIPAddress": "",
        "deviceLocation": "",
        "deviceLongitude": "",
        "deviceLatitude": "",
        "deviceUser": "",
        "deviceIMEINumber" : "",
        "deviceTorEnabled" : "",
        "deviceFirstSeen" : "",
        "deviceLastSeen" : ""
    }
 }

Input Parameters

ParameterFormatRequiredDetails
"transactionID"StringYThe transaction ID to dispute.
"disputeReason"StringNThe reason for the dispute (free text).
"disputeType"StringNThe type of the dispute - default: UNAUTHORIZED
"declarationAcknowledged"BooleanYThis value must always be "true" - otherwise, return Error Code 1001.
"deviceId"StringNThe user's unique device identifier.
"deviceType"StringNThe type of the user's device
"deviceName"StringNThe name given to the user's device.
"deviceOperatingSystem"StringNThe OS of the user's device.
"deviceIPAddress"StringNCurrent IP Address for the device.
"deviceLocation"StringNCurrent location for the device.
"deviceLongitude"StringNDevice's location longitude.
"deviceLatitude"StringNDevice's location latitude.
"deviceUser"StringNThe name of the user of the device.
"deviceIMEINumber"StringNMobile device unique equipment identifier.
"deviceTorEnabled"BooleanNDevice is/is not using Tor browser.
"deviceFirstSeen"String; ISO 8601 yyyy-mm-ddNDate/Time the device was first used to access Avenu.
"deviceLastSeen"String; ISO 8601 yyyy-mm-ddNDate/Time the device was last used to access Avenu.

Example Response

{
     "disputeID": "",
     "dateUpdated": "",
     "memo": "",
     "amount": "",
     "currencyType": "",  
     "status": ""
 }

Response Elements

ElementDetails
disputeIDUnique ID to track this dispute case
dateUpdatedDispute updated date in format ISO 8601 YYYY-MM-DD
memoMemo associated with the dispute
amountDispute amount
currencyTypeDispute currency
statusDispute status

Error Codes

codeMessageDescription
1001"Missing required field"
1002"Error - Invalid data structure"
1003"Error - Invalid data"
1010"Error - Transaction Not Allowed"
AE7000"Call Issuer"This error will be returned when a dispute is sent for a DEBIT or DEBIT_FUND transaction type. When a customer needs to dispute a debit card funding transaction, they should reach out to the phone number listed on their card in order to dispute the transaction.

[GET] customer/v1/dispute

Get dispute status

The current status of a dispute can be retrieved by passing the unique disputeID as a parameter to the dispute endpoint.

Example [GET] Request

{{avenu_base_url}}/customer/v1/dispute/{{disputeID}}

Request Parameter

ParameterFormatRequired
"disputeID"UUID StringY

Example Response

{
    "disputeID": "",
    "dateUpdated": "",
    "memo": "",
    "amount": xxx,
    "currencyType": "",
    "status": ""
}

Response Elements

ElementDetails
disputeIDUnique ID to track this dispute case
dateUpdatedDispute updated date in format ISO 8601 YYYY-MM-DD
memoMemo associated with the dispute
amountDispute amount
currencyTypeDispute currency
statusDispute status