How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Silverflow Disputes API

The Disputes API from Silverflow — 9 operation(s) for disputes.

Silverflow Disputes API is one of 50 APIs that Silverflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Disputes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 10 operations across 9 paths, and defines 107 schemas. It is described by OpenAPI 3.2.0, at version 1.417.0.

Requests are made against 3 base URLs: https://eu-west-1.api.silverflow.com/v1, https://us-east-2.api.silverflow.com/v1, https://eu-west-1.api-sbx.silverflow.com/v1.

10 operations 9 paths 107 schemas 5 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.417.0
Base URL
https://eu-west-1.api.silverflow.com/v1
Authentication
HTTP Basic, HTTP Bearer, API Key
License
Commercial
Resource Areas
1

Authentication & Security 3

Silverflow Disputes API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (ApiKey). It accepts HTTP bearer tokens (JWT) (BearerToken). An API key is passed in the header as - (MutualTLS). By default, every request must be authenticated.

  • ApiKey — The primary method of authenticating to the Silverflow API is through API keys. API keys can be created by calling the [createApiKey](operation/createApiKey) e…
  • BearerToken — Bearer tokens are temporary security credentials that can be used to authorize 'third parties' (bearers) access to the Silverflow API on behalf of the agent. T…
  • MutualTLS — The client must set up mTLS connection with a valid X.509 client certificate signed by a customer-provided CA (certificate authority) that is registered to a s…

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 5 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Disputes 10
GET
/disputes
List Disputes
getDisputes 17 params → 200401403429
GET
/disputes/{disputeKey}
Get Dispute
getDispute 1 param → 200401403404429
GET
/disputes/{disputeKey}/documents
List Dispute Documents
getDisputeDocumentsMetadata 6 params → 200401403404429
POST
/disputes/{disputeKey}/documents
Add Dispute Document
addDisputeDocumentsMetadata 1 param body → 200401403404429
POST
/disputes/{disputeKey}/accept
Accept Dispute
acceptDispute 2 params → 200400401403404409412429
POST
/disputes/{disputeKey}/submitEvidence
Submit Evidence
submitEvidence 2 params body → 200400401403404409412429
POST
/disputes/{disputeKey}/rejectEvidence
Reject Evidence
rejectEvidence 2 params body → 200400401403404409412429
POST
/disputes/{disputeKey}/defend
Defend Dispute
defendDispute 2 params body → 200400401403404409412429
GET
/disputes/{disputeKey}/eventHistory
List Dispute History Events
getDisputeEventHistory 6 params → 200401403404429
GET
/disputes/eventHistory/{eventHistoryKey}
Get Dispute History Event
getEventHistory 1 param → 200401403404429

Schemas 107

The contract defines 107 schemas that model the data the API accepts and returns. The most detailed are Dispute (30 properties), DisputeEventHistory (18 properties), Document (15 properties), EventDetails (13 properties). Each schema is shown below with its type and property counts.

DisputeEventHistory
object
A Dispute
18 properties 13 required
disputeHandling
object
Represents the disputesHandling options set on the merchant acceptor by the time dispute has been received.
1 property
DisputeDocumentWithoutFile
filename
string
UUID formatted file name.
DisputeEventHistoryPage
disputeResponseReasonIdMastercardCollaboration
string
Unique code of a disputeResponseReason
clearingDateTime
string
Clearing datetime of the disputed authorization.
DisputeEventHistoryKey
string
Uniquely identifies a dispute history event
documents_status
string
The current status of the document.
schemas-cardNetwork
string
The card network
components-schemas-offsetToken
string
openapi_components-schemas-version
integer
The version of this object
disputeStages
array
The list of stages of a Dispute
disputeStatuses
array
The list of (flow)statuses of a Dispute
schemas-status
string
The status of a Dispute.
disputeResponseReasonIdMastercard
string
Unique code of a disputeResponseReason
partialDefenseAmountValue
integer
The partial defense amount in minor units. Must be at least 1 and less than the total dispute amount. For example, $12.34 should be represented as 1234.
disputeDate
string
Datetime of Dispute submission in [date time string format](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/GlobalObjects/Datedatetimestringf…
disputeSubResponseReasonId
string
Unique code of a disputeSubResponseReason.
schemas-mid
string
Merchant ID assigned to the merchant (or Payfac) by the acquirer. Acceptors that use the same BIN, Doing Business As name, and location must have the same mid.…
defenseOptions
array
Represents the possible defense options when the Dispute is in a defendable status.
PageWithMoreAndTotalItems
object
3 properties
DisputesPage
schemas-localTransactionDateTime
string
The date and time of the transaction
submittedDefense
object
Represents the most recent defense evidence, submitted by an Acquirer or a Merchant. submittedEvidence is filled when defense is initiated (dispute status = de…
10 properties
DefendVisaPreArbitration
object
1 property
schemas-fraudLiability
string
Identifies whether the acquirer or issuer has the liability of the dispute.
RejectDispute
object
1 property 1 required
lastEventDate
string
The datetime of the last event in card network.
eventDate
Datetime of an action mentioned in the history record. (e.g. dispute acceptance date)
isPartial
boolean
Flag to indicate whether the Dispute was issued for the entire purchase amount.
totalItems
number
SubmitEvidenceAmexChargeback
chargeInfo
object
Charge related information
9 properties 3 required
DisputeDocument
defenseOption
object
2 properties
SubmitEvidenceMastercardChargeback
object
3 properties
disputeResponseReasonIdAmexRFI
string
Unique code of a disputeResponseReason.
EventFile
object
Object containing summarized information of a document
8 properties 7 required
Dispute
object
A Dispute
30 properties 23 required
messageText
string
This field is passed on to element DE72 (Data Record) in the second presentment clearing file. Mastercard chargeback rules prescribe how to fill this field dep…
DefendVisaChargeback
object
5 properties 1 required
closed
boolean
Indicates if a Dispute has one of the final statuses: closedAccepted, closedWon, closedLost.
disputeSubResponseReason
object
Represents the reason a Dispute is claimed invalid.
2 properties 2 required
amexResponseText
string
Free text field which can be used to provide extra guidance with the Dispute.
actionDueDate
string
Due date for the next action in "YYYY-MM-DD" format.
acquirerReferenceNumber
string
Unique identifier assigned by the acquirer at clearing. Used to identify the transaction with the card networks.
owner
string
The owner of a Dispute Document
documentKey
string
Uniquely identifies a document
DisputeDocumentsPage
openapi_components-schemas-lastModified-2
string
The date and time this object was last modified
SubmitEvidenceAmexRFI
openapi_components-schemas-acceptorKey
string
Uniquely identifies a Merchant Acceptor.
moreItems
boolean
EventFiles
array
refundAmountValue
integer
Optional amount that was or will be refunded to the customer (AMEX RFI only). The amount should be provided in minor units. For example $12.34 should be encode…
common_status
string
The status of the object
openapi_components-schemas-Amount
object
An amount encoded as an object with a value in minor units and a currency code.
2 properties 2 required
creditOrReversalDetail
object
Mandatory for Visa Disputes when defense response reason is Credit or reversal processed. Represents the credit or reversal details.
3 properties 3 required
DisputeDefense
Document
object
A Document
15 properties 7 required
cardInfo
object
Card related information
3 properties 1 required
DisputeCategory
string
actionRequired
boolean
Indicates if a Dispute is in a status where it can be accepted or defended by the acquirer.
DefendMastercardChargeback
object
3 properties 1 required
schemas-last4
string
The last 4 digits of the card. This property will be removed on 24 September 2025. Use maskedNumber instead.
components-schemas-merchantKey
string
Uniquely identifies a Merchant
maskedNumber
string
The card number used to create this charge, masked according to PCI standards. For card numbers with 16 or more digits, the first 8 and the last 4 digits are v…
components-schemas-agentKey
string
Uniquely identifies an Agent
Reason
object
Object containing dispute reason category, code and description.
3 properties 2 required
elaborationVisa
string
Free text field which can be used to provide extra guidance with the Dispute.
EventDetails
object
Most fields are network-specific and are only returned in events for specific stage/status combinations.
13 properties
SubmitEvidenceMastercardPreArbitration
object
1 property
schemas-FreeTextField
string
schemas-acquirerBin
string
Acquirer BIN. The BIN number as assigned by the card network. For Mastercard, this is also referred to as the Acquirer Reference ID.
DefendAmexRFI
object
3 properties 2 required
schema
string
disputeKey
string
Uniquely identifies a Dispute.
DefendAmexChargeback
object
1 property 1 required
clearingReferenceNumber
string
Silverflow generated unique clearing identifier. Only present for American Express since it has the same value as the ARN for Visa and Mastercard.
networkReference
string
Unique ID assigned by the network when authorizing. This ID is returned in the response of the authorization.
openapi_components-schemas-created-3
string
The date and time this object was created
disputeResponseReasonIdVisa
string
Unique code of a disputeResponseReason.
DefendMastercardPreArbitration
object
1 property
components-schemas-PageWithMoreItems
object
2 properties
schemas-transactionReference
string
Unique ID used to identify the transaction that is assigned by the merchant or payment service provider.
openapi_components-schemas-amountValue-2
integer
The amount in minor units. For example $12.34 should be encoded as 1234. Note that not all currencies have 2 minor units. Some have three or zero.
SubmitEvidenceVisaPreArbitration
object
1 property
disputeStatusReason
string
SubmitEvidence
disputeReference
string
Unique identifier assigned by the card networks.
DefendMastercardCollaboration
object
2 properties 2 required
disputeResponseReasonId
originalFilenameInput
string
Name of the file. Allows letters, numbers, whitespaces and characters ()
disputeStage
string
The current stage of a Dispute
SubmitEvidenceVisaChargeback
object
5 properties
originalFilename
string
Name of the file. Allows letters, numbers, whitespaces and characters ()
networkDisputeId
string
Uniquely identifies a Dispute within a card network.
schemas-ProblemDetail
object
The 'problem detail' object relays detailed information about the error that occurred. It is defined by [RFC 7807 - Problem Details for HTTP APIs](https://tool…
5 properties
isPartialDefense
boolean
Flag to indicate whether the Dispute was partially defended (should be set to true if the defense amount is lower than the dispute amount).
disputeResponseReason
object
Represents the reason a Dispute is being defended.
2 properties 2 required
disputeStatus
string
The current (flow)status of a Dispute
contentType
string
Accepted Content-Types
DocumentCreate
object
A Document
2 properties 1 required
openapi_components-schemas-currencyCode-3
string
The three-letter ISO code of the currency. European ISO Currency Codes | Country — Currency | Code | Numeric | Minor Units | | --------------------------------…
schemas-chargeKey
string
Uniquely identifies a charge.
DocumentWithoutFile
object
11 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

silverflow-disputes-api-openapi.yml Raw ↑

Other APIs Silverflow publishes across the network.

Silverflow 3DS Authentication API
Silverflow Agents API
Silverflow AMMF Submission Events API
Silverflow API Keys API
Silverflow BEP Authentication API
Silverflow Bins API
Silverflow Card Info API
Silverflow Card Management API
Silverflow Card Network Reports API
Silverflow Charge Actions API
Silverflow Charges Events API
Silverflow Charges Reports API
Where this information came from

This is an independent, third-party profile of Silverflow Disputes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.