Read Dispute

Intent

Reads the dispute without changing it.

When to call it

Call this after your application has received or stored the identifier for the dispute.

Access boundary

Authorize the request with a token that carries disputes:read or disputes:write.

Successful result

A successful request returns 200. The response schema below defines the body your integration receives.

Operational notes

Get a dispute by ID.

Scopes: disputes:read disputes:write

GET

disputes

{id}

Read Dispute

curl --request GET \
  --url https://api.getruba.com/v1/disputes/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getruba.com/v1/disputes/{id}', 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.getruba.com/v1/disputes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.getruba.com/v1/disputes/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.getruba.com/v1/disputes/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "resolved": true,
  "closed": true,
  "amount": 123,
  "tax_amount": 123,
  "currency": "<string>",
  "reason": "fraudulent",
  "evidence_due_by": "2023-11-07T05:31:56Z",
  "past_due": true,
  "order_id": "<string>",
  "payment_id": "<string>",
  "customer": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "email_verified": true,
    "name": "John Doe",
    "billing_name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404",
    "external_id": "usr_1337",
    "email": "customer@example.com",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "case_id": "<string>"
}

{
  "error": "<string>",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Path Parameters

string<uuid4>

required

The dispute ID.

Response

Successful Response

Schema representing a dispute.

A dispute is a challenge raised by a customer or their bank regarding a payment.

created_at

string<date-time>

required

The time Ruba created this record.

modified_at

string<date-time> | null

required

The time this record last changed.

string<uuid4>

required

The stable identifier for this record.

status

enum<string>

required

Status of the dispute. prevented means we issued a refund before the dispute was escalated, avoiding any fees.

Available options:

prevented,

early_warning,

needs_response,

under_review,

lost,

won

Examples:

"needs_response"

"prevented"

resolved

boolean

required

Whether the dispute has been resolved (won or lost).

Example:

false

closed

boolean

required

Whether the dispute is closed (prevented, won, or lost).

Example:

false

amount

integer

required

Amount in cents disputed.

Example:

1000

tax_amount

integer

required

Tax amount in cents disputed.

Example:

200

currency

string

required

Currency code of the dispute.

Example:

"usd"

reason

string | null

required

The reason for the dispute as reported by the card network (e.g. fraudulent, product_not_received). None until the processor reports it.

Example:

"fraudulent"

evidence_due_by

string<date-time> | null

required

Deadline to submit evidence in response to the dispute. None when no response is required.

past_due

boolean

required

Whether the evidence submission deadline has passed.

Example:

false

order_id

string<uuid4>

required

The ID of the order associated with the dispute.

Example:

"57107b74-8400-4d80-a2fc-54c2b4239cb3"

payment_id

string<uuid4>

required

The ID of the payment associated with the dispute.

Example:

"42b94870-36b9-4573-96b6-b90b1c99a353"

customer

DisputeCustomer · object

required

The customer who was charged for the disputed payment.

Show child attributes

case_id

string<uuid4> | null

required

The ID of the support case for this dispute, if one was opened.

List Disputes### Intent Reads the available disputes as a pageable collection without changing them. ### When to call it Call this when an interface, sync, or support workflow needs to inspect disputes. Use the filters and paging controls shown below to limit the result. ### Access boundary Authorize the request with a token that carries `disputes:read` or `disputes:write`. ### Successful result A successful request returns `200`. The response schema below defines the body your integration receives. ### Operational notes List disputes. **Scopes**: `disputes:read` `disputes:write`

Read Dispute

curl --request GET \
  --url https://api.getruba.com/v1/disputes/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getruba.com/v1/disputes/{id}', 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.getruba.com/v1/disputes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.getruba.com/v1/disputes/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.getruba.com/v1/disputes/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "resolved": true,
  "closed": true,
  "amount": 123,
  "tax_amount": 123,
  "currency": "<string>",
  "reason": "fraudulent",
  "evidence_due_by": "2023-11-07T05:31:56Z",
  "past_due": true,
  "order_id": "<string>",
  "payment_id": "<string>",
  "customer": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "email_verified": true,
    "name": "John Doe",
    "billing_name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404",
    "external_id": "usr_1337",
    "email": "customer@example.com",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "case_id": "<string>"
}

{
  "error": "<string>",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Read This First

Create a Sale

Collect and Reconcile

Manage Recurring Revenue

Model Customer Access

Power the Customer Portal

Configure the Platform

React to State Changes

Read Dispute

Intent

When to call it

Access boundary

Successful result

Operational notes

Authorizations

Path Parameters

Response