Open the exception case of an integration item that stopped

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/integration-cases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "<string>",
  "purpose": "<string>",
  "step": "<string>",
  "attempts": 1,
  "externalCode": "<string>",
  "fields": [
    "<string>"
  ],
  "httpStatus": 299,
  "receivableRef": "<string>"
}
'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/integration-cases"

	payload := strings.NewReader("{\n  \"destination\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"step\": \"<string>\",\n  \"attempts\": 1,\n  \"externalCode\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"httpStatus\": 299,\n  \"receivableRef\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination: '<string>',
    purpose: '<string>',
    step: '<string>',
    attempts: 1,
    externalCode: '<string>',
    fields: ['<string>'],
    httpStatus: 299,
    receivableRef: '<string>'
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/integration-cases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/integration-cases"

payload = {
    "destination": "<string>",
    "purpose": "<string>",
    "step": "<string>",
    "attempts": 1,
    "externalCode": "<string>",
    "fields": ["<string>"],
    "httpStatus": 299,
    "receivableRef": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "assignmentFundId": "<string>",
  "assignmentSetId": "<string>",
  "caseType": "<string>",
  "detail": "<string>",
  "id": "<string>",
  "openedAt": "<string>",
  "receivableRef": "<string>",
  "state": "<string>",
  "disposition": "<string>",
  "resolvedAt": "<string>",
  "resolvedBy": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Open the exception case of an integration item that stopped

Opens an integration_item_stuck case for one item, keyed on set, receivableRef, destination, purpose and step, or answers the case already open for it: a retry writes nothing and gets the same case. Refused with LENDER-0541 for an unknown set, LENDER-0545 before approval, LENDER-0548 for a receivable the set no longer carries and LENDER-1502 once the set is cancelled or settled.

POST

api

assignment

sets

{setId}

integration-cases

Open the exception case of an integration item that stopped

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/integration-cases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "<string>",
  "purpose": "<string>",
  "step": "<string>",
  "attempts": 1,
  "externalCode": "<string>",
  "fields": [
    "<string>"
  ],
  "httpStatus": 299,
  "receivableRef": "<string>"
}
'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/integration-cases"

	payload := strings.NewReader("{\n  \"destination\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"step\": \"<string>\",\n  \"attempts\": 1,\n  \"externalCode\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"httpStatus\": 299,\n  \"receivableRef\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination: '<string>',
    purpose: '<string>',
    step: '<string>',
    attempts: 1,
    externalCode: '<string>',
    fields: ['<string>'],
    httpStatus: 299,
    receivableRef: '<string>'
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/integration-cases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/integration-cases"

payload = {
    "destination": "<string>",
    "purpose": "<string>",
    "step": "<string>",
    "attempts": 1,
    "externalCode": "<string>",
    "fields": ["<string>"],
    "httpStatus": 299,
    "receivableRef": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "assignmentFundId": "<string>",
  "assignmentSetId": "<string>",
  "caseType": "<string>",
  "detail": "<string>",
  "id": "<string>",
  "openedAt": "<string>",
  "receivableRef": "<string>",
  "state": "<string>",
  "disposition": "<string>",
  "resolvedAt": "<string>",
  "resolvedBy": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

setId

string<uuid>

obrigatório

Assignment set identifier.

Corpo

application/json

destination

string

obrigatório

The integration destination.

Pattern: ^[a-z][a-z0-9_]{0,31}$

itemStatus

enum<string>

obrigatório

Where the item stopped.

Opções disponíveis:

rejected,

blocked,

outcome_unknown

purpose

string

obrigatório

Why the item is delivered, for example assignment_offer.

Pattern: ^[a-z][a-z0-9_]{0,63}$

step

string

obrigatório

The integration step that stopped, for example contract or attachment.ccb.

Pattern: ^[a-z][a-z0-9_.-]{0,63}$

attempts

integer<int64>

Delivery attempts made.

Intervalo obrigatório: x >= 0

externalCode

string

The destination's code, or the orchestrator's reason.

Pattern: ^[A-Za-z0-9_.:-]{0,64}$

fields

string[] | null

Names of the fields the destination refused.

Maximum array length: 20

Pattern: ^[A-Za-z][A-Za-z0-9_.]{0,63}$

httpStatus

integer<int64>

The destination's last HTTP status; 0 or absent when nothing answered.

Intervalo obrigatório: 0 <= x <= 599

receivableRef

string

The receivable the item is about; absent for a step about the whole set.

Maximum string length: 128

Resposta

assignmentFundId

string

obrigatório

The fund it was offered to.

assignmentSetId

string

obrigatório

The set this case happened to.

caseType

string

obrigatório

What happened: repeated_cut, remessa_conflict, remessa_divergence, offer_sent_without_remessa (the fund returned no file within its window after the offer was sent), derecognition_unpostable (the receivable's product carries no write-off posting rule), derecognition_unvaluable (the receivable's carried figure cannot be read or cannot be trusted), derecognition_already_sold (another assignment set has already sold this receivable), derecognition_unsellable (the receivable is not this tenant's to sell: suspended, excluded, ported or already discharged), derecognition_contract_closed (the receivable's debt closed after approval; the detail names the cause), transfer_absent (the administrator accepted a receivable whose title movement no registradora ever confirmed), registry_command_unconfirmed (a title transfer commanded at the registradora that never came back settled), assigned_contract_passthrough, fund_payment_divergence (what the fund paid for the lot differs from what its paid lines are due beyond the lot's tolerance; the acceptance is held, and detail.fundPayment names the numbers, amountPaid net of what the desk refunded for lines taken out), integration_item_stuck (an integration item the orchestrator could not deliver; one case per set, receivable, destination, purpose and step), or one of the lifecycle orphans.

detail

string

obrigatório

A JSON object with what a desk needs to act: the cut tally that tripped the brake, the two conflicting digests, the references that failed to reconcile. A case whose line was taken out of its lot carries removedLine: the line's frozen faceValue, assignmentPrice, discountAmount and currency, factsRecorded (paid, transferred) for how far the fund got with it, and refundToFund, what the exception desk settles with the fund for it: what the fund paid for the line less its share of the lot's accepted or tolerated difference. An integration_item_stuck case carries destination, purpose, step, itemStatus and attempts, with httpStatus, externalCode and fields when known, and once resolved by resend or delivered-outside, resolutionAction: resend or delivered_outside.

string

obrigatório

Case identifier (uuid).

openedAt

string

obrigatório

UTC instant the case was opened (RFC3339).

receivableRef

string

obrigatório

The one receivable this case is about; empty when the case is about a whole file.

state

string

obrigatório

open or resolved.

disposition

string

What they decided; resolved cases only.

resolvedAt

string

UTC instant it was disposed of (RFC3339); resolved cases only.

resolvedBy

string

Validated identity that disposed of it; resolved cases only.

Produtos de empréstimo do Brasil

Operações de consignado

Ciclo de vida do produto

Versões do produto

Configuração do produto

Tabelas de taxa flutuante

Modelos de documento

Solicitações de Empréstimo

Instrumentos de crédito

Informações regulatórias e risco

Quitação e pré-pagamento

Baixas contábeis e recuperação de crédito

Visão geral e auditoria da conta

Encargos e cronograma

Pagamentos

Transações

Recebíveis de pagamento devolvido

Fundos de cessão

Lotes de cessão

Exceções e dossiês da cessão

Contabilidade

Painéis da carteira

Jurisdições

Impostos

Acesso de parceiros

Sessão

Data de negócio

Streaming

Tratamento de erros

Eventos

Open the exception case of an integration item that stopped

Autorizações

Parâmetros de caminho

Corpo

Resposta