1. Home
  2. Arbiter
  3. Arbiter 1.0
  4. Create Dispute

Create Dispute

Use this endpoint to log a new dispute

Sample Request

POST <base url>/arbiter/api/v1/disputes
Content-Type: application/json
Authorization: Bearer <AccessToken>
 
{
"remoteTranId": 2137647237,
"dispenseType": "No Dispense",
"logComments": "Non-Receipt of Goods, Services or Cash"
}

Request Payload Description

FieldField NameData TypeLengthRequiredDescription
1remoteTranIdLong
YesRemote transaction Id of the transaction. You get this from the result of the search performed using the search endpoint
2dispenseTypeString
YesExpected Value is any one of these: [ No Dispense | Partial Dispense ]
3logComentsString
YesComments that specify the nature of the dispute e.g “Non-Receipt of Goods, Services or Cash”

RESPONSE

Response Message  field description

FieldField NameDescription
1disputeLogIdThe ID of the dispute
2disputeLogCodeThe dispute log code
3acquirerCodeThe acquirer code
4panThe pan used for the transaction
5stanThe Systen Trace Audit Number of the transaction
6terminalIdThe Terminal ID the transaction was done on
7terminalTypeThe type of terminal that was used for the transaction
8tranDateTimeThe date the transaction was done
9settleDateTimeThe proposed settlement date
10tranTypeThe type of transaction that was done
11tranAmtThe transaction amount
12surchargeAmtThe surcharge amount on the transaction
13dispenseTypeThe dispense type (either partial or none)
14logCommentsComment that was sent when creating the dispute
15acceptCommentsComments when accepting the claim
16declineCommentsComments when a dispute is declined
17validatedByUser who validated the claim
18validatedOnThe date the dispute was validated
19penaltyFeeThe penalty fee
20oldStatusPrevious status of the dipsute
21isVerified
22requestedAmountThe amount that was requested during the transaction
23dispensedAmountThe amount dispensed during the transaction
24remoteTranIdThe remote transaction ID
25settleCurrencyCodeThe settlement currency code
26tranCurrencyCodeThe transaction currency code
27settleCurrencyAlphaCodeThe settlement currency alpha code
28tranCurrencyAlphaCodeThe transaction currency alpha code
29disputeExpiryDateThe expected date the dispute is supposed to have closed
30code
31issuerDomainnCodeThe domain code of the issuer
32acquirerDomainCodeThe domain code of the acquirer
33merchantDomainCodeThe domain code of the merchant
34acquirerNameThe name of the acquirer
35issuerNameThe name of the issuer
36imageEvidence
37disputeJournalJournal sent by the acquirer
38claimTypeThe type of dispute
39mechantTypeThe type of merchant
40customerReferenceIDThe customer reference ID
41fromAccountNoThe account number that was debited during the transaction
42retrievalReferenceNrThe retrieval reference number
43settlementAmountThe amount to be refunded
44disputeRegionThe region when the transaction took place
45statusThe current status of the dispute
46lastUpdatedByThe last person to update the dispute
47lastUpdatedOnThe date the dispute was last updated
48createdByThe person who created the dispute
49createdOnThe 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
}
Was this article helpful to you? Yes No

How can we help?