Create Dispute

Use this to log a dispute


Field NameDescriptionTypeRequiredConstraints
transactionTypeThe name of the dispute typeStringRequiredrefer to Get Transaction Types
transactionReferenceThe unique identifier of the transactionStringRequired
disputeAmountTypeThe type of dispute amountEnumRequiredFULL or PARTIAL
disputeAmountThe amount to be disputedLongConditional - if disputeAmountType is PARTIAL
commentdispute commentStringOptional
reasonCodeThe code of the dispute reasonStringRequiredrefer to Get Dispute Reason
categoryThe name of the dispute categoryStringRequiredrefer to Get Dispute Categories

Sample Request


    "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


Field NameDescriptionTypeConstraint
logCodeThe log code of the disputeString
issuerCodeThe domain code of the issuerString
issuerThe domain name of the issuerString
acquirerCodeThe domain code of the acquirerString
acquirerThe domain name of the acquirerString
merchantCodeThe domain code of the merchant, if applicableString
merchantThe domain name of the merchant, if applicableString
customerReferenceThe reference of the customerString
transactionStoreThe store of the transactionString
transactionReferenceThe unique reference of the transaction in the storeString
transactionDateThe UTC date and time of the transactionString
transactionTypeThe type of the transactionStringrefer to Get Transaction Types
transactionAmountThe amount of the transactionString
surchargeAmountThe surcharge (or fee) of the transaction, if applicableString
transactionCurrencyCodeThe currency of the transaction. Format: ISO 4217 numericString
settlementAmountThe settlement amount of the transactionString
settlementCurrencyCodeThe currency of the transaction settlement. Format: ISO 4217 numericString
terminalTypeThe type of the terminalString
disputeAmountTypeThe type of the dispute amountEnumFULL or PARTIAL
disputeAmountThe amount of the disputeString
additionalInfoAny additional data from the transactionJSON String
reasonCodeThe code of reason of the disputeStringrefer to Get Dispute Reasons
reasonThe reason for the disputeStringrefer to Get Dispute Reasons
categoryThe category of the disputeStringrefer to Get Dispute Categories
regionThe region of the disputeString
merchantDisputantIndicates whether the dispute is managed by the merchant or the acquirerBoolean
domainCodeThe domain code of the issuer of the disputeString
statusThe current status of the disputeString
statusStartDateThe UTC date and time the current status beganDateTime
createdByThe user that logged the disputeString
createdOnThe UTC date and time the dispute was loggedDateTime
accountNumberThe transaction account numberString
merchantEmailThe email address of the merchant if applicableString
panThe masked PAN of the card used in the transactionString

Sample Response

    "logCode": "VDM00II62952",
    "issuerCode": "VDM",
    "issuer": "VFD MFB",
    "acquirerCode": "ZIB",
    "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",
    "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"
Click Try It! to start a request and see the response here!