GET
/
disputes
/
list
curl --request GET \
  --url https://api.staging.bnplx.io/disputes/list \
  --header 'api-key: <api-key>'
[
  {
    "dispute_id": "<string>",
    "payment_id": "<string>",
    "attempt_id": "<string>",
    "amount": "<string>",
    "currency": "AED",
    "dispute_stage": "pre_dispute",
    "dispute_status": "dispute_opened",
    "connector": "<string>",
    "connector_status": "<string>",
    "connector_dispute_id": "<string>",
    "connector_reason": "<string>",
    "connector_reason_code": "<string>",
    "challenge_required_by": "2023-11-07T05:31:56Z",
    "connector_created_at": "2023-11-07T05:31:56Z",
    "connector_updated_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "profile_id": "<string>",
    "merchant_connector_id": "<string>"
  }
]

Authorizations

api-key
string
header
required

Use the API key created under your merchant account from the GreenBanana dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Query Parameters

limit
integer | null

The maximum number of Dispute Objects to include in the response

dispute_status
enum<string>

The status of dispute

Available options:
dispute_opened,
dispute_expired,
dispute_accepted,
dispute_cancelled,
dispute_challenged,
dispute_won,
dispute_lost
dispute_stage
enum<string>

The stage of dispute

Available options:
pre_dispute,
dispute,
pre_arbitration
reason
string | null

The reason for dispute

connector
string | null

The connector linked to dispute

received_time
string | null

The time at which dispute is received

received_time.lt
string | null

Time less than the dispute received time

received_time.gt
string | null

Time greater than the dispute received time

received_time.lte
string | null

Time less than or equals to the dispute received time

received_time.gte
string | null

Time greater than or equals to the dispute received time

Response

200
application/json
The dispute list was retrieved successfully

The response is of type object[].