Create Dispute

REQUEST

Field Name	Description	Type	Required	Constraints
transactionType	The name of the dispute type	String	Required	refer to Get Transaction Types
transactionReference	The unique identifier of the transaction	String	Required
disputeAmountType	The type of dispute amount	Enum	Required	FULL or PARTIAL
disputeAmount	The amount to be disputed	Long	Conditional - if disputeAmountType is PARTIAL
comment	dispute comment	String	Optional
reasonCode	The code of the dispute reason	String	Required	refer to Get Dispute Reason
category	The name of the dispute category	String	Required	refer to Get Dispute Categories

Sample Request

{{base_url}}/api/v1/disputes

{
    "transactionType": "AGENCY_BANKING_TRANSFER",
    "transactionReference": "000000007078_007078_2TEPH519_-100000.00_0200",
    "disputeAmountType": "Full",
    "comment": "Transaction disputed because the transaction status was not confirmed by the destination institution",
    "reasonCode": "RG",
    "category": "Chargeback",
    "disputeAmount": 1000.00
}

RESPONSE

Field Name	Description	Type	Constraint
logCode	The log code of the dispute	String
issuerCode	The domain code of the issuer	String
issuer	The domain name of the issuer	String
acquirerCode	The domain code of the acquirer	String
acquirer	The domain name of the acquirer	String
merchantCode	The domain code of the merchant, if applicable	String
merchant	The domain name of the merchant, if applicable	String
customerReference	The reference of the customer	String
transactionStore	The store of the transaction	String
transactionReference	The unique reference of the transaction in the store	String
transactionDate	The UTC date and time of the transaction	String
transactionType	The type of the transaction	String	refer to Get Transaction Types
transactionAmount	The amount of the transaction	String
surchargeAmount	The surcharge (or fee) of the transaction, if applicable	String
transactionCurrencyCode	The currency of the transaction. Format: ISO 4217 numeric	String
settlementAmount	The settlement amount of the transaction	String
settlementCurrencyCode	The currency of the transaction settlement. Format: ISO 4217 numeric	String
terminalType	The type of the terminal	String
disputeAmountType	The type of the dispute amount	Enum	FULL or PARTIAL
disputeAmount	The amount of the dispute	String
additionalInfo	Any additional data from the transaction	JSON String
reasonCode	The code of reason of the dispute	String	refer to Get Dispute Reasons
reason	The reason for the dispute	String	refer to Get Dispute Reasons
category	The category of the dispute	String	refer to Get Dispute Categories
region	The region of the dispute	String
merchantDisputant	Indicates whether the dispute is managed by the merchant or the acquirer	Boolean
domainCode	The domain code of the issuer of the dispute	String
status	The current status of the dispute	String
statusStartDate	The UTC date and time the current status began	DateTime
createdBy	The user that logged the dispute	String
createdOn	The UTC date and time the dispute was logged	DateTime
accountNumber	The transaction account number	String
merchantEmail	The email address of the merchant if applicable	String
pan	The masked PAN of the card used in the transaction	String

Sample Response

{
    "logCode": "VDM00II62952",
    "issuerCode": "VDM",
    "issuer": "VFD MFB",
    "acquirerCode": "ZIB",
    "acquirer": "ZENITH BANK INTERNATIONAL",
    "merchantCode": "",
    "merchant": "",
    "customerReference": "506136******2056_1012305241",
    "transactionStore": "RJService",
    "transactionReference": "000000007078_007078_2TEPH519_-100000.00_0200",
    "transactionDate": "2023-08-22T08:01:41Z",
    "transactionType": "AGENCY_BANKING_TRANSFER",
    "transactionAmount": "NGN 1,000.00",
    "surchargeAmount": "NGN 0.00",
    "transactionCurrencyCode": "566",
    "settlementAmount": "NGN 1,000.00",
    "settlementCurrencyCode": "566",
    "terminalType": "2",
    "disputeAmountType": "Full",
    "disputeAmount": "NGN 1,000.00",
    "additionalInfo": {
        "Card Acceptor Code": "2TEPLA000000002",
        "Card Acceptor Location": "T Olakazzy big Ltd  007078 2TEPH519 LANG",
        "Card Scheme": "Verve",
        "Has Merchant": true,
        "Merchant Type": "REGULAR",
        "Response Code": "00",
        "Response Description": "Approved",
        "Retrieval Reference Number": "000000007078",
        "Settled": true,
        "Sink Node Name": "SWTASPsnk",
        "Source Node Name": "SWTTAPTsrc",
        "Stan": "007078",
        "Terminal Id": "2TEPH519"
    },
    "reasonCode": "RG",
    "reason": "Non-Receipt of Goods and Services",
    "category": "Chargeback",
    "region": "DOMESTIC_AGENCY_TRANSFERS",
    "merchantDisputant": false,
    "domainCode": "VDM",
    "status": "Chargeback",
    "statusStartDate": "2023-09-28T15:26:53.867Z",
    "createdBy": "Emmanuel.Kpoudosu@ISW",
    "createdOn": "2023-09-28T15:26:54.097Z",
    "accountNumber": "1012305241",
    "merchantEmail": "",
    "pan": "506136******2056"
}