Use this to log a dispute
Resource URL: <base url>arbiter/api/v1/disputes
HTTP Verb: POST
Authentication: User Access Token
REQUEST
| Field | Type | Required | Constraints |
|---|---|---|---|
| transactionType | String | Required | |
| transactionReference | String | Required | |
| disputeAmountType | Enum | Required | FULL, PARTIAL |
| disputeAmount | Decimal | Conditional – If disputeAmountType is PARTIAL | |
| comment | String | Optional | |
| reasonCode | String | Required | |
| category | Enum | Required | Dispute Categories |
Sample Request
{"transactionType": "BillPayment","transactionReference": "1286176","disputeAmountType": "Partial","disputeAmount": 1000,"comment": "Log with comment","reasonCode": "AP","category": "Chargeback"}
RESPONSE
| Field | Description |
|---|---|
| id | The id of the dispute |
| logCode | The log code of the dispute |
| issuerCode | The domain code of the issuer |
| issuer | The domain name of the issuer |
| acquirerCode | The domain code of the acquirer |
| acquirer | The domain name of the acquirer |
| merchantCode | The domain code of the merchant, if applicable |
| merchant | The domain name of the merchant, if applicable |
| merchantReference | The reference of the transaction in the merchant’s system, if applicable |
| customerReference | The reference of the customer |
| transactionStore | The store of the transaction |
| transactionReference | The unique reference of the transaction in the store |
| transactionType | The type of the transaction |
| transactionDate | The UTC date and time of the transaction |
| transactionAmount | The amount of the transaction |
| surchargeAmount | The surcharge (or fee) of the transaction, if applicable |
| transactionCurrencyCode | The currency of the transaction. Format: ISO 4217 numeric |
| settlementAmount | The settlement amount of the transaction |
| settlementCurrencyCode | The currency of the transaction settlement. Format: ISO 4217 numeric |
| schemeAmount | The amount of the transaction in the card scheme’s currency |
| schemeCurrencyCode | The currency of the transaction from the card scheme’s system. Format: ISO 4217 numeric |
| terminalType | The type of the terminal |
| disputeAmountType | The type of the dispute amount |
| disputeAmount | The amount of the dispute |
| additionalInfo | Any additional data from the transaction |
| reasonCode | The code of reason of the dispute |
| reason | The reason of the dispute |
| category | The category of the dispute |
| region | The region of the dispute |
| merchantDisputant | Indicates whether the dispute is managed by the merchant or the acquirer |
| domainCode | The domain code of the initiator of the dispute |
| status | The current status of the dispute |
| statusStartDate | The UTC date and time the current status began |
| statusScheduledEndDate | The UTC date and time the current status is scheduled to expire, if applicable |
| createdBy | The user that logged the dispute |
| createdOn | The UTC date and time the dispute was logged |
Sample Response
{"id": 551,"logCode": "FBN00II551","issuerCode": "FBN","issuer": "FIRST BANK OF NIGERIA","acquirerCode": "GTB","acquirer": "GUARANTY TRUST BANK","merchantCode": "AIRTEL","merchant": "Airtel Nigeria","merchantReference": "","customerReference": "0802221412","transactionStore": "PAYDIRECT","transactionReference": "1286176","transactionDate": "2018-05-30T08:04:20Z","transactionType": "BillPayment","transactionAmount": "NGN 1,550.00","surchargeAmount": "NGN 100.00","transactionCurrencyCode": "566","terminalType": "Bank Branch","disputeAmountType": "Partial","disputeAmount": "NGN 1,000.00","additionalInfo": {"Payment Reference": "FBN|BRH|AIRTEL|31-05-2018|603793","Has Merchant": true,"Card Scheme": "Verve","Response Description": "Approved or completed successfully","Settled": true,"Terminal Id": "3IPD0029","Pan": "506099*********7158","Merchant Type": "REGULAR","Response Code": "00"},"reasonCode": "AP","reason": "Recurring Payments","category": "Chargeback","region": "Domestic Bill Payment","merchantDisputant": false,"domainCode": "FBN","status": "Chargeback","statusStartDate": "2019-02-28T11:15:23.403Z","statusScheduledEndDate": "2019-03-20T11:15:23.403Z","createdBy": "Jideobi.Onuora@FBN","createdOn": "2019-02-28T11:15:23.41Z"}