List disputes - Lerian

List disputes

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

package main

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

func main() {

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

	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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "hasMore": true,
  "items": [
    {
      "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"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

GET

/

v1

/

disputes

List disputes

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

package main

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

func main() {

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

	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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "hasMore": true,
  "items": [
    {
      "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"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

Autorizações

Authorization

string

header

obrigatório

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

Cabeçalhos

X-Request-Id

string

A unique identifier for tracing the request across services.

Parâmetros de consulta

state

enum<string>

Filter by dispute state Filter by state

Opções disponíveis:

DRAFT,

OPEN,

PENDING_EVIDENCE,

WON,

LOST

category

enum<string>

Filter by dispute category Filter by category

Opções disponíveis:

BANK_FEE_ERROR,

UNRECOGNIZED_CHARGE,

DUPLICATE_TRANSACTION,

OTHER

date_from

string

Start date filter (RFC 3339 format) Filter from date, inclusive lower bound. Accepts an RFC 3339 timestamp or a bare date (YYYY-MM-DD); a bare date is taken at 00:00:00 UTC

Exemplo:

"2025-01-01T00:00:00Z"

date_to

string

End date filter (RFC 3339 format) Filter to date, inclusive upper bound. Accepts an RFC 3339 timestamp or a bare date (YYYY-MM-DD); a bare date covers the whole day through 23:59:59.999999999 UTC

Exemplo:

"2025-01-31T23:59:59Z"

cursor

string

The cursor value for retrieving the next page of results. Cursor for pagination (opaque)

limit

integer<int64>

padrão:20

The maximum number of items to include in the response. Maximum number of records to return

Intervalo obrigatório: 1 <= x <= 200

sort_by

enum<string>

Sort by field

Opções disponíveis:

id,

created_at,

updated_at,

state,

category

sort_order

enum<string>

Sort order

Opções disponíveis:

asc,

desc

Resposta

List of disputes with cursor pagination

hasMore

boolean

obrigatório

Exemplo:

true

items

object[] | null

obrigatório

Page of disputes (max 200 per page)

Maximum array length: 200

Show child attributes

limit

integer<int64>

obrigatório

Intervalo obrigatório: 1 <= x <= 200

Exemplo:

20

nextCursor

string

Exemplo:

"eyJpZCI6IjEyMyJ9"

prevCursor

string

Exemplo:

"eyJpZCI6IjEyMiJ9"