Pular para o conteúdo principal
GET
/
v1
/
matching
/
candidates
Listar candidatos a correspondência de uma transação
curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/matching/candidates \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "amountDelta": "<string>",
      "dateDeltaDays": 123,
      "ruleId": "<string>",
      "ruleType": "<string>",
      "score": 50,
      "transaction": {
        "amount": "<string>",
        "currency": "<string>",
        "date": "<string>",
        "id": "<string>",
        "sourceId": "<string>",
        "baseAmount": "<string>",
        "externalId": "<string>"
      },
      "why": {
        "amountMatch": true,
        "currencyMatch": true,
        "dateMatch": true,
        "referenceScore": 0.5,
        "matchedKeys": [
          {
            "agreed": true,
            "field": "<string>"
          }
        ]
      }
    }
  ],
  "targetTransactionId": "<string>"
}

Autorizações

Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Parâmetros de consulta

contextId
string<uuid>
obrigatório

Context ID the transaction belongs to ID do contexto ao qual a transação pertence

transactionId
string<uuid>
obrigatório

Target transaction to find counterparts for. For an exception, resolve its transaction id first, then pass it here. Transação alvo para a qual encontrar contrapartes. Para uma exceção, resolva primeiro seu ID de transação e então passe-o aqui.

limit
integer<int64>
padrão:50

Maximum number of ranked proposals to return Número máximo de propostas ranqueadas a retornar

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

Resposta

OK

items
object[] | null
obrigatório

Propostas candidatas ranqueadas (maior pontuação primeiro)

Maximum array length: 200
targetTransactionId
string
obrigatório

A transação para a qual as contrapartes foram propostas

Exemplo:

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