Skip to main content

Retrieve List of Disputes

GET 
/entities/{entity-id}/disputes

Retrieves a list of disputes for entity based on the provided parameters.

Request​

Path Parameters

    entity-id stringrequired

    Entity Id

Query Parameters

    from_date daterequired

    From Date

    to_date daterequired

    To Date

    response_date_sort stringrequired

    Possible values: [CreateDate, UpdateDate]

    Response Date Sort

    retrieve_files boolean

    Retrieve Files

    Default value: false
    offset integer

    Offset

    Default value: 0
    size integer

    Size

    Default value: 100

Responses​

OK

Schema

    totalCount integer

    disputes

    object[]

  • Array [

    • id Id (string)

    Id

    creationDate date-time
    verdict Verdict (string)

    Possible values: [won, lost, undetermined, resolved]

    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

    If an error occurred on the request side, an error code is returned in this parameter.

    code stringrequired

    If an error occurred on the request side, an error code is returned in this parameter.

    Possible values: <= 11 characters

    Example: 7000.1000
    reason string

    If an error occurred on the request side, then an error reason is returned in this parameter.

    Possible values: <= 400 characters

    Example: Internal Processing Error
Loading...