Escolha quem emite a CCB
Uma versão de produto declara
terms.creditInstrumentMode quando você a cria. O valor é lender_emitted (o padrão) ou client_issued. Uma versão nunca muda, então outro emissor exige uma versão nova.
O Lender emite a CCB
1
Publique um template de documento
O produto precisa de um template publicado antes de o Lender emitir. Crie um rascunho com
POST /api/v1/loan-products/{productId}/document-templates e publique-o. Publicar uma nova versão substitui a ativa. Sem template ativo, a emissão responde LENDER-0616.2
Aprove a proposta e emita antes da liberação
O Lender só emite para uma proposta
approved. Uma proposta que já foi desembolsada responde LENDER-0602, então emita entre a aprovação e a liberação.3
Emita a CCB
POST /api/v1/loan-applications/{applicationId}/credit-instruments recebe idempotencyKey no corpo, não em um cabeçalho, e um bloco parties com nomes e documentos do emissor e do credor, os locais de emissão e de pagamento e qualquer outro campo que o template declare. A mesma chave devolve a mesma CCB, com X-Idempotency-Replayed: true. A mesma chave com outro bloco parties é recusada.4
Liste e baixe
GET .../credit-instruments lista as emissões, da mais nova para a mais antiga. Uma emissão anterior traz supersededByInstrumentId. O bloco issuance diz se a proposta pode ter uma CCB emitida agora (canEmit) e, quando não pode, o código que a emissão devolveria (refusalCode). GET .../credit-instruments/{instrumentId}/download devolve o PDF que o Lender guarda.Sua instituição emite a CCB
Em uma versão
client_issued, o Lender não emite CCB. POST .../credit-instruments responde LENDER-0601, e a lista mostra canEmit: false com o mesmo refusalCode. Gere o documento e colete a assinatura por conta própria, e depois registre a CCB assinada. Guarde o digest do documento como ele estava antes da assinatura: o registro é recusado com LENDER-0608 quando originalDocumentDigest falta ou quando creditInstrumentId, que aponta uma CCB emitida pelo Lender, é enviado.
Registre a CCB assinada
Registre a CCB assinada depois que as partes assinarem, em uma proposta
approved ou disbursed, nos dois modos. POST /api/v1/loan-applications/{applicationId}/signed-credit-instrument recebe:
Esta rota não recebe o cabeçalho
X-Idempotency. Enviar o mesmo documento de novo devolve o registro mais novo, com X-Idempotency-Replayed: true, e ignora qualquer metadado que difira no reenvio: ele não atualiza o registro.
Troque a CCB assinada
Um documento diferente é recusado com
LENDER-0604, a menos que seja uma troca. Para trocar, leia o registro mais novo e envie o documento novo com supersedes igual ao id desse registro e um replacementReason de uma linha, com até 500 caracteres. Os dois vão juntos. O registro trocado continua no histórico, e vale o mais novo.
Um documento que já pertence a um registro anterior não pode voltar como troca: o Lender responde LENDER-0613. Para voltar a esse conteúdo, envie um arquivo novo, como uma nova exportação, cujos bytes sejam diferentes.
Leia e baixe
GET /api/v1/loan-applications/{applicationId}/signed-credit-instrument devolve o registro mais novo. custodian diz quem guarda o PDF: lender ou integrator. GET .../signed-credit-instrument/download entrega o PDF que o Lender guarda. Para um registro cujo custodian é integrator, ele responde LENDER-0614: o PDF fica com o integrador, e o signedDocumentDigest da leitura confere os bytes dele.
Recusas
A página de referência de cada operação lista as outras recusas dela: as páginas de emissão, de registro, de leitura e de download, e as de criação e de publicação do template.
No console
O console mostra a CCB de cada proposta em Instrumentos de crédito: veja Instrumentos de crédito.
Próximos passos
Origine um empréstimo
Leve uma proposta do envio até a liberação.