Get match run results

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

package main

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

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups"

	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/matching/runs/{runId}/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

{
  "hasMore": true,
  "items": [
    {
      "confidence": 85,
      "contextId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2025-01-15T10:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "items": [
        {
          "allocatedAmount": "1000.00",
          "allocatedCurrency": "USD",
          "allowPartial": false,
          "createdAt": "2025-01-15T10:30:00Z",
          "expectedAmount": "1000.00",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "matchGroupId": "550e8400-e29b-41d4-a716-446655440000",
          "transactionId": "550e8400-e29b-41d4-a716-446655440000",
          "updatedAt": "2025-01-15T10:30:00Z",
          "side": "LEFT",
          "sourceId": "550e8400-e29b-41d4-a716-446655440000",
          "sourceName": "Bank statement"
        }
      ],
      "runId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "PROPOSED",
      "updatedAt": "2025-01-15T10:30:00Z",
      "confirmedAt": "2025-01-15T10:35:00Z",
      "reasonCodes": [
        "FX_RATE_VARIANCE"
      ],
      "rejectedReason": "amounts do not match within tolerance",
      "ruleId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

GET

matching

runs

{runId}

groups

Get match run results

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

package main

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

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups"

	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/matching/runs/{runId}/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

{
  "hasMore": true,
  "items": [
    {
      "confidence": 85,
      "contextId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2025-01-15T10:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "items": [
        {
          "allocatedAmount": "1000.00",
          "allocatedCurrency": "USD",
          "allowPartial": false,
          "createdAt": "2025-01-15T10:30:00Z",
          "expectedAmount": "1000.00",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "matchGroupId": "550e8400-e29b-41d4-a716-446655440000",
          "transactionId": "550e8400-e29b-41d4-a716-446655440000",
          "updatedAt": "2025-01-15T10:30:00Z",
          "side": "LEFT",
          "sourceId": "550e8400-e29b-41d4-a716-446655440000",
          "sourceName": "Bank statement"
        }
      ],
      "runId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "PROPOSED",
      "updatedAt": "2025-01-15T10:30:00Z",
      "confirmedAt": "2025-01-15T10:35:00Z",
      "reasonCodes": [
        "FX_RATE_VARIANCE"
      ],
      "rejectedReason": "amounts do not match within tolerance",
      "ruleId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "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 caminho

runId

string<uuid>

obrigatório

Run ID

Parâmetros de consulta

contextId

string<uuid>

obrigatório

Context ID Context ID the run belongs to

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

cursor

string

The cursor value for retrieving the next page of results. Opaque pagination cursor

sort_order

enum<string>

The order used to sort the results. Sort order

Opções disponíveis:

asc,

desc

sort_by

enum<string>

The field used to sort the results. Sort field

Opções disponíveis:

id,

created_at,

status

status

enum<string>

Filter by match-group lifecycle status. Applied server-side so the filter is honest across all pages, not just the loaded one.

Opções disponíveis:

PROPOSED,

CONFIRMED,

REJECTED,

REVOKED

Resposta

Indicates that the request was successful and the response contains the expected data.

hasMore

boolean

obrigatório

Exemplo:

true

items

object[] | null

obrigatório

Page of match groups

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"

Primeiros passos

API de Contextos de Configuração

API de Regras de Correspondência

API de Fontes de Dados

API de Mapeamento de Campos

API de Tabelas de Tarifas

API de Configuração de Regras de Tarifas

API de Agendamentos

Fluxo de exceções

Ações em massa

Comentários

Credenciais de callback

API de Disputas

API de Jobs de Exportação

API de Governança

Jobs de ingestão

Layouts e formatos

Revisões de extração

Extração de documentos

Execuções de correspondência

Correspondência manual e ajustes

Candidatos e itens em aberto

Sugestões de regras

Painel e métricas

Relatórios

Exportações

Status da descoberta

Conexões de descoberta

Extrações

Conexões de agregadores

Webhooks de agregadores

Tratamento de erros

Eventos

Get match run results

Autorizações

Cabeçalhos

Parâmetros de caminho

Parâmetros de consulta

Resposta