Use this endpoint to log a new dispute
Sample Request
POST <base url>/arbiter/api/v1/disputesContent-Type: application/jsonAuthorization: Bearer <AccessToken>
{"remoteTranId": 2137647237,"dispenseType": "No Dispense","logComments": "Non-Receipt of Goods, Services or Cash"}
Request Payload Description
| Field | Field Name | Data Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | remoteTranId | Long | Yes | Remote transaction Id of the transaction. You get this from the result of the search performed using the search endpoint | |
| 2 | dispenseType | String | Yes | Expected Value is any one of these: [ No Dispense | Partial Dispense ] | |
| 3 | logComents | String | Yes | Comments that specify the nature of the dispute e.g “Non-Receipt of Goods, Services or Cash” |
RESPONSE
Response Message field description
| Field | Field Name | Description |
|---|---|---|
| 1 | disputeLogId | The ID of the dispute |
| 2 | disputeLogCode | The dispute log code |
| 3 | acquirerCode | The acquirer code |
| 4 | pan | The pan used for the transaction |
| 5 | stan | The Systen Trace Audit Number of the transaction |
| 6 | terminalId | The Terminal ID the transaction was done on |
| 7 | terminalType | The type of terminal that was used for the transaction |
| 8 | tranDateTime | The date the transaction was done |
| 9 | settleDateTime | The proposed settlement date |
| 10 | tranType | The type of transaction that was done |
| 11 | tranAmt | The transaction amount |
| 12 | surchargeAmt | The surcharge amount on the transaction |
| 13 | dispenseType | The dispense type (either partial or none) |
| 14 | logComments | Comment that was sent when creating the dispute |
| 15 | acceptComments | Comments when accepting the claim |
| 16 | declineComments | Comments when a dispute is declined |
| 17 | validatedBy | User who validated the claim |
| 18 | validatedOn | The date the dispute was validated |
| 19 | penaltyFee | The penalty fee |
| 20 | oldStatus | Previous status of the dipsute |
| 21 | isVerified | |
| 22 | requestedAmount | The amount that was requested during the transaction |
| 23 | dispensedAmount | The amount dispensed during the transaction |
| 24 | remoteTranId | The remote transaction ID |
| 25 | settleCurrencyCode | The settlement currency code |
| 26 | tranCurrencyCode | The transaction currency code |
| 27 | settleCurrencyAlphaCode | The settlement currency alpha code |
| 28 | tranCurrencyAlphaCode | The transaction currency alpha code |
| 29 | disputeExpiryDate | The expected date the dispute is supposed to have closed |
| 30 | code | |
| 31 | issuerDomainnCode | The domain code of the issuer |
| 32 | acquirerDomainCode | The domain code of the acquirer |
| 33 | merchantDomainCode | The domain code of the merchant |
| 34 | acquirerName | The name of the acquirer |
| 35 | issuerName | The name of the issuer |
| 36 | imageEvidence | |
| 37 | disputeJournal | Journal sent by the acquirer |
| 38 | claimType | The type of dispute |
| 39 | mechantType | The type of merchant |
| 40 | customerReferenceID | The customer reference ID |
| 41 | fromAccountNo | The account number that was debited during the transaction |
| 42 | retrievalReferenceNr | The retrieval reference number |
| 43 | settlementAmount | The amount to be refunded |
| 44 | disputeRegion | The region when the transaction took place |
| 45 | status | The current status of the dispute |
| 46 | lastUpdatedBy | The last person to update the dispute |
| 47 | lastUpdatedOn | The date the dispute was last updated |
| 48 | createdBy | The person who created the dispute |
| 49 | createdOn | The date the dispute was created |
Sample Response (Success)
{"disputeLogId":2642492,"disputeLogCode":"GTB002642492","acquirerCode":"FBN ","pan":"539983******0103","stan":"196011","terminalId":"20117042","terminalType":"POS ","tranDatetime":1408660080000,"settleDatetime":null,"tranType":"Goods and services ","tranAmt":8000.0,"surchargeAmt":0.0,"dispenseType":"No Dispense ","logComments":"Non-Receipt of Goods","acceptComments":null,"declineComments":null,"validatedBy":null,"validatedOn":null,"penaltyFee":0.0,"oldStatus":null,"isVerified":"No","requestedAmount":8000.0,"dispensedAmount":0.0,"remoteTranId":2137647237,"settleCurrencyCode":"566","tranCurrencyCode":null,"settleCurrencyAlphaCode":"NGN","tranCurrencyAlphaCode":"NGN","disputeExpiryDate":1432710808117,"code":null,"issuerDomainCode":null,"acquirerDomainCode":null,"merchantDomainCode":null,"acquirerName":null,"issuerName":null,"imageEvidence":null,"disputeJournal":null,"claimType":null,"merchantType":null,"customerReferenceId":null,"fromAccountNo":null,"retrievalReferenceNr":null,"settlementAmount":null,"disputeRegion":null,"status":"Pending ","lastUpdatedBy":null,"lastUpdatedOn":null,"createdBy":"testgtb ","createdOn":1432106007133}
Sample Response (Failed)
{"code":"10400","description":"Process cannot continue because you are not authorized to perform this action","errors":null}