Skip to main content
GET
/
v4
/
core
/
companies
/
{companyId}
/
disputes
List disputes
curl --request GET \
  --url https://api.integrations.commenda.io/v4/core/companies/{companyId}/disputes \
  --header 'api_key: <api-key>'
import requests

url = "https://api.integrations.commenda.io/v4/core/companies/{companyId}/disputes"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.integrations.commenda.io/v4/core/companies/{companyId}/disputes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/companies/{companyId}/disputes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.integrations.commenda.io/v4/core/companies/{companyId}/disputes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.integrations.commenda.io/v4/core/companies/{companyId}/disputes")
  .header("api_key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.integrations.commenda.io/v4/core/companies/{companyId}/disputes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "data": [
      {
        "rootfi_id": 123,
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rootfi_updated_at": "2023-11-07T05:31:56Z",
        "platform_id": "<string>",
        "transaction_id": "<string>",
        "invoice_id": "<string>",
        "contact_id": "<string>",
        "amount": 123,
        "reason_code": "<string>",
        "gateway": "<string>",
        "gateway_dispute_id": "<string>",
        "evidence_due_date": "2023-11-07T05:31:56Z",
        "resolution_date": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "total_count": 123,
    "next": "<string>",
    "prev": "<string>"
  },
  "request_id": "<string>"
}

Authorizations

​
api_key
string
header
required

Your Commenda Integrations API key, sent in the api_key header.

Path Parameters

​
companyId
integer
required

Commenda company id.

Query Parameters

​
limit
integer
default:20

Max records to return.

Required range: x <= 100
​
next
string

Cursor for the next page (from a previous response).

​
prev
string

Cursor for the previous page.

​
include_deleted_records
boolean

Include soft-deleted records.

​
return_count
boolean

Include the total match count in the response.

​
status[eq]
enum<string>

Exact match on status.

Available options:
OPEN,
UNDER_REVIEW,
WON,
LOST,
WARNING_CLOSED,
UNKNOWN
​
status[in]
string

Comma-separated status values (OR match).

​
reason[eq]
enum<string>

Exact match on reason.

Available options:
FRAUDULENT,
DUPLICATE,
UNRECOGNIZED,
QUALITY_ISSUE,
NOT_RECEIVED,
CANCELED,
OTHER
​
reason[in]
string

Comma-separated reason values (OR match).

​
currency_id[eq]
enum<string>

Exact match on currency_id.

Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BOV,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLF,
CLP,
CNY,
COP,
COU,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MXV,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
USN,
UYI,
UYU,
UYW,
UZS,
VED,
VES,
VND,
VUV,
WST,
XAF,
XAG,
XAU,
XBA,
XBB,
XBC,
XBD,
XCD,
XDR,
XOF,
XPD,
XPF,
XPT,
XSU,
XTS,
XUA,
XXX,
YER,
ZAR,
ZMW,
ZWG
​
currency_id[in]
string

Comma-separated currency_id values (OR match).

​
gateway[eq]
string

Exact match on gateway.

​
gateway[in]
string

Comma-separated gateway values (OR match).

​
rootfi_integration_type[eq]
string

Exact match on rootfi_integration_type.

​
rootfi_integration_type[in]
string

Comma-separated rootfi_integration_type values (OR match).

​
rootfi_updated_at[eq]
string

Exact match on rootfi_updated_at.

​
rootfi_updated_at[in]
string

Comma-separated rootfi_updated_at values (OR match).

​
rootfi_updated_at[gte]
string

rootfi_updated_at greater-than-or-equal.

​
rootfi_updated_at[lte]
string

rootfi_updated_at less-than-or-equal.

​
created_at[eq]
string

Exact match on created_at.

​
created_at[in]
string

Comma-separated created_at values (OR match).

​
created_at[gte]
string

created_at greater-than-or-equal.

​
created_at[lte]
string

created_at less-than-or-equal.

​
updated_at[eq]
string

Exact match on updated_at.

​
updated_at[in]
string

Comma-separated updated_at values (OR match).

​
updated_at[gte]
string

updated_at greater-than-or-equal.

​
updated_at[lte]
string

updated_at less-than-or-equal.

Response

200 - application/json

A paginated list of disputes.

​
data
object
required
​
request_id
string
required