Buscar duplicata por ID ou IUD

Retorna os dados completos de uma duplicata, incluindo manifestações (statements) e avalistas.

O parâmetro registered_invoice_ref aceita dois formatos:

  • ID interno do hub (id)
  • IUD é o Identificador Único da Duplicata atribuído pela escrituradora

Quando a duplicata já foi escriturada e possui IUD salvo no hub, os dados são consultados diretamente na escrituradora e sincronizados localmente caso haja mudanças relevantes. Quando não possui IUD (duplicata ainda não escriturada), os dados são retornados apenas a partir do banco local.

Path Params
string
required

ID interno do hub (id) ou IUD (iud) da duplicata na escrituradora

Query Params
string
enum

Devolve uma negociação simulada em negotiations, com simulated: true, para testar a integração sem passar pela jornada do Financiador. Os valores seguem os tipos de negotiations[].type. Disponível apenas em sandbox/staging e para clientes habilitados: a habilitação é feita pela Shipay, a pedido do cliente. Se o cliente não estiver habilitado, o parâmetro é ignorado e a consulta retorna normalmente, sem erro. Não grava dados nem dispara webhooks. Valor inválido responde 422 com os valores aceitos.

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json