Skip to main content

Retrieve Dispute Details

GET 
/entities/{entity-id}/disputes/{dispute-id}

Retrieves the dispute details for entity based on the provided parameters.

Request​

Path Parameters

    entity-id stringrequired

    Entity Id

    dispute-id stringrequired

    Dispute Id

Query Parameters

    receive_files boolean

    Receive Files

    Default value: false

Responses​

OK

Schema

    disputes

    object

    Dispute

    id Id (string)

    Id

    creationDate date-time
    verdict Verdict (string)

    Possible values: [won, lost, undetermined]

    transaction

    object

    Transaction

    id int64

    Transactionid

    date date-time
    merchantTransactionId string
    arn string
    amount number
    currency Currency (string)

    Currency

    Possible values: >= 3 characters and <= 3 characters

    paymentOption string
    maskedCardNumber string
    availableActions AvailableActions (string)[]

    Possible values: [ACCEPT, PARTIAL, REJECT]

    disputeEvents

    object[]

  • Array [

    • id Id (string)

    Id

    updateDate date-time
    expirationDate date-time

    status

    object

    CodeDescription

    code string
    description string
    disputeAmount number
    rejectAmount number
    currency Currency (string)

    Currency

    Possible values: >= 3 characters and <= 3 characters

    remarks string

    disputeReason

    object

    CodeDescription

    code string
    description string

    rejectReason

    object

    CodeDescription

    code string
    description string

    files

    object[]

  • Array [

    • id Id (string)

    Id

    name string
    data string

  • ]

    • initiatedBy string

    Possible values: [Issuer, Acquirer, Scheme]

  • ]

    • result

    object

    required

    status BaseResultStatus (string)required

    Status of the request: success | error

    Possible values: [success, error]

    errors

    object

    Object describing the error in case such occurred during processing of the request.

    code stringrequired

    Code of the error in case such occurred during processing of the request.

    Possible values: <= 11 characters

    reason string

    Description of the error in case such occurred during processing of the request.

    Possible values: <= 400 characters

Loading...