Get all disputes - Rain

Get all disputes

curl --request GET \
  --url https://api-dev.rain.xyz/v1/issuing/disputes \
  --header 'Api-Key: <api-key>'

const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};

fetch('https://api-dev.rain.xyz/v1/issuing/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-dev.rain.xyz/v1/issuing/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-dev.rain.xyz/v1/issuing/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))

}

require 'uri'
require 'net/http'

url = URI("https://api-dev.rain.xyz/v1/issuing/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

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "disputeAmount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "disputeType": "fraud",
    "textEvidence": "<string>",
    "resolvedAt": "2023-11-07T05:31:56Z",
    "transaction": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "cardholderUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cardholderFirstName": "<string>",
      "cardholderLastName": "<string>",
      "merchantName": "<string>",
      "postedAt": "2023-11-07T05:31:56Z"
    },
    "hasFileEvidence": true,
    "informationalOnly": true,
    "attachmentCount": 1
  }
]

GET

/

issuing

/

disputes

Get all disputes

curl --request GET \
  --url https://api-dev.rain.xyz/v1/issuing/disputes \
  --header 'Api-Key: <api-key>'

const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};

fetch('https://api-dev.rain.xyz/v1/issuing/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-dev.rain.xyz/v1/issuing/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-dev.rain.xyz/v1/issuing/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))

}

require 'uri'
require 'net/http'

url = URI("https://api-dev.rain.xyz/v1/issuing/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

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "disputeAmount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "disputeType": "fraud",
    "textEvidence": "<string>",
    "resolvedAt": "2023-11-07T05:31:56Z",
    "transaction": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "cardholderUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cardholderFirstName": "<string>",
      "cardholderLastName": "<string>",
      "merchantName": "<string>",
      "postedAt": "2023-11-07T05:31:56Z"
    },
    "hasFileEvidence": true,
    "informationalOnly": true,
    "attachmentCount": 1
  }
]

Authorizations

Api-Key

string

header

required

Query Parameters

companyId

string<uuid>

For corporate cards, id of the company to get disputes for

userId

string<uuid>

Id of the user to get disputes for

transactionId

string<uuid>

Id of the transaction to get disputes for

status

enum<string>

Filter disputes by status

Available options:

pending,

inReview,

accepted,

rejected,

canceled

cursor

string

The id of the resource after which to start fetching

limit

integer

default:20

The number of resources to fetch

Required range: 1 <= x <= 100

Response

Successful operation

id

string<uuid>

required

The dispute's unique identifier

transactionId

string<uuid>

required

The transaction's unique identifier

status

enum<string>

required

The status of the dispute

Available options:

pending,

inReview,

accepted,

rejected,

canceled,

resolvedByMerchant

disputeAmount

integer

required

Disputed amount in cents

createdAt

string<date-time>

required

The time at which the dispute was created

disputeType

enum<string>

The type of dispute

Available options:

fraud,

creditNotProcessed,

serviceNotReceived,

merchandiseIssue,

other

textEvidence

string

The textual evidence for the dispute

Maximum string length: 65535

resolvedAt

string<date-time>

The time at which the dispute was resolved

transaction

object

Details of the transaction associated with the dispute

Show child attributes

hasFileEvidence

boolean

Indicates whether file evidence has been uploaded for the dispute

informationalOnly

boolean

When true, the dispute was recorded only and was not submitted to the card network.

attachmentCount

integer

The number of attachments uploaded for the dispute

Required range: x >= 0