Africa Fintech FoundryDeveloper Portal
Get API keys
Escrow API

Disputes

Raise buyer, seller or merchant disputes as multipart submissions, then attach a seller response to an existing dispute.

POST

Raise buyer dispute

/api/Disputes/raiseDisputeBuyer
Raises a dispute on behalf of the buyer and uploads supporting evidence.
Parameters
TransactionIdstringEscrow transaction identifier.
DisputeCategoryinteger enumOne of 1–5; meanings are not named in the schema.
PreferredResolutioninteger enumOne of 1 or 2; meanings are not named in the schema.
RefundAccountNumberstringRefund account number.
RefundAccountNamestringRefund account name.
RefundBankNamestringRefund bank name.
DescriptionstringDispute description.
AdditionalCommentsstringAdditional comments.
EvidenceDocumentsfile[]requiredEvidence documents.
// multipart form
TransactionId=ESC-8F2C-0114
DisputeCategory=1
PreferredResolution=1
RefundAccountNumber=0000000002
RefundAccountName=ADAEZE NWOSU
RefundBankName=Access Bank
Description=Item not as described
AdditionalComments=The supplied fabric differs from the listing.
EvidenceDocuments=photo-1.jpg,photo-2.jpg
POST

Raise seller dispute

/api/Disputes/raiseDisputeSeller
Raises a dispute on behalf of the seller and uploads supporting evidence.
Parameters
TransactionIdstringEscrow transaction identifier.
DisputeCategorySellerinteger enumThe schema publishes only the value 0 and does not name it.
DescriptionstringDispute description.
EvidenceDocumentsfile[]requiredEvidence documents.
// multipart form
TransactionId=ESC-8F2C-0114
DisputeCategorySeller=0
Description=Buyer has not confirmed delivery
EvidenceDocuments=delivery-proof.jpg
POST

Raise merchant dispute

/api/Disputes/raiseDisputeMerchant
Raises a dispute on behalf of the merchant with buyer and refund details.
Parameters
TransactionIdstringEscrow transaction identifier.
BuyerFullNamestringBuyer full name.
BuyerEmailstringBuyer email address.
BuyerPhoneNumberstringBuyer phone number.
RefundAccountNamestringRefund account name.
RefundAccountNumberstringRefund account number.
RefundBankNamestringRefund bank name.
Reasoninteger enumOne of 1–4; meanings are not named in the schema.
DisputeCategoryinteger enumOne of 1–5; meanings are not named in the schema.
PreferredResolutioninteger enumOne of 1 or 2; meanings are not named in the schema.
DescriptionstringrequiredDispute description.
AdditionalCommentsstringAdditional comments.
EvidenceDocumentsfile[]requiredEvidence documents.
// multipart form
TransactionId=ESC-8F2C-0114
BuyerFullName=Adaeze Nwosu
BuyerEmail=buyer@example.invalid
BuyerPhoneNumber=08000000002
RefundAccountName=ADAEZE NWOSU
RefundAccountNumber=0000000002
RefundBankName=Access Bank
Reason=1
DisputeCategory=1
PreferredResolution=1
Description=Merchant escalation
AdditionalComments=Manual review requested.
EvidenceDocuments=evidence.pdf
POST

Submit seller dispute response

/api/Disputes/submitSellerDisputeResponse
Submits the seller’s response and optional supporting documents to a dispute.
Parameters
DisputeIdstringDispute identifier.
ResponseMessagestringSeller response.
AdditionalCommentsstringAdditional comments.
EvidenceDocumentsfile[]Supporting evidence documents.
// multipart form
DisputeId=DSP-0001
ResponseMessage=The listed item was shipped in full.
AdditionalComments=Waybill attached.
EvidenceDocuments=waybill.pdf