Get a dispute - Lerian

Get a dispute

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/disputes/{disputeId} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/disputes/{disputeId}"

	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))

}

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

fetch('https://matcher.sandbox.lerian.net/v1/disputes/{disputeId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "category": "BANK_FEE_ERROR",
  "createdAt": "2025-01-15T10:30:00Z",
  "description": "Transaction amount differs from expected",
  "exceptionId": "550e8400-e29b-41d4-a716-446655440001",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "openedBy": "user@example.com",
  "state": "OPEN",
  "updatedAt": "2025-01-15T10:30:00Z",
  "evidence": [
    {
      "comment": "Bank statement attached",
      "disputeId": "550e8400-e29b-41d4-a716-446655440001",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "submittedAt": "2025-01-15T10:30:00Z",
      "submittedBy": "user@example.com",
      "fileUrl": "https://storage.example.com/evidence/doc123.pdf"
    }
  ],
  "reopenReason": "New evidence discovered",
  "resolution": "Counterparty confirmed error"
}

GET

/

v1

/

disputes

/

{disputeId}

Get a dispute

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/disputes/{disputeId} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/disputes/{disputeId}"

	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))

}

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

fetch('https://matcher.sandbox.lerian.net/v1/disputes/{disputeId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "category": "BANK_FEE_ERROR",
  "createdAt": "2025-01-15T10:30:00Z",
  "description": "Transaction amount differs from expected",
  "exceptionId": "550e8400-e29b-41d4-a716-446655440001",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "openedBy": "user@example.com",
  "state": "OPEN",
  "updatedAt": "2025-01-15T10:30:00Z",
  "evidence": [
    {
      "comment": "Bank statement attached",
      "disputeId": "550e8400-e29b-41d4-a716-446655440001",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "submittedAt": "2025-01-15T10:30:00Z",
      "submittedBy": "user@example.com",
      "fileUrl": "https://storage.example.com/evidence/doc123.pdf"
    }
  ],
  "reopenReason": "New evidence discovered",
  "resolution": "Counterparty confirmed error"
}

Authorizations

Authorization

string

header

required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id

string

A unique identifier for tracing the request across services.

Path Parameters

disputeId

string<uuid>

required

The unique identifier of the dispute. Dispute ID (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440001"

Response

Successfully retrieved dispute

category

enum<string>

required

Dispute category: BANK_FEE_ERROR (incorrect fee), UNRECOGNIZED_CHARGE, DUPLICATE_TRANSACTION, AMOUNT_MISMATCH, or OTHER

Available options:

BANK_FEE_ERROR,

UNRECOGNIZED_CHARGE,

DUPLICATE_TRANSACTION,

AMOUNT_MISMATCH,

OTHER

Example:

"BANK_FEE_ERROR"

createdAt

string

required

Creation timestamp as an RFC 3339 timestamp

Example:

"2025-01-15T10:30:00Z"

description

string

required

Description of the dispute

Example:

"Transaction amount differs from expected"

exceptionId

string

required

Identifier of the exception this dispute is for (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440001"

id

string

required

Unique identifier for the dispute (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

openedBy

string

required

User who opened the dispute

Example:

"user@example.com"

state

enum<string>

required

Dispute state: DRAFT, OPEN, PENDING_EVIDENCE (awaiting evidence), WON, or LOST

Available options:

DRAFT,

OPEN,

PENDING_EVIDENCE,

WON,

LOST

Example:

"OPEN"

updatedAt

string

required

Last update timestamp as an RFC 3339 timestamp

Example:

"2025-01-15T10:30:00Z"

evidence

object[] | null

Evidence items submitted for this dispute (max 50)

Maximum array length: 50

Show child attributes

reopenReason

string

Reason recorded when the dispute was reopened

Example:

"New evidence discovered"

resolution

string

Resolution description recorded when the dispute was closed

Example:

"Counterparty confirmed error"