Accesstage

Sobre as APIs de duplicatas

Fluxo de operações

Webhook

## Apresentação

Esta documentação descreve a integração com a API de Antecipação de Duplicatas para entidades sacadas, cedentes e cessionárias, em operações de antecipação de duplicatas de Risco Sacado e/ou Risco Cedente.

## Autenticação

A autenticação utilizada nesta API é baseada no protocolo OAuth 2.0. Para realizar a autenticação, é necessário seguir o fluxo padrão do OAuth 2.0, fornecendo as credenciais corretas e obtendo um token de acesso válido. Esse token de acesso será utilizado para autorizar as solicitações aos endpoints protegidos da API.

## Error Codes

A API utiliza os seguintes códigos de erro para indicar falhas nas requisições:

- **400 - Bad Request:** ocorre quando os dados enviados estão incorretos ou fora do padrão. O código de erro 400 é retornado juntamente com uma mensagem explicativa sobre o motivo da falha.
    

- **404 - Not Found:** indica que o recurso solicitado não foi encontrado ou que o nível de acesso é insuficiente para acessá-lo. O código de erro 404 é retornado juntamente com uma mensagem detalhando o motivo da falha.

Autenticação

## Apresentação

Esta documentação descreve a integração com a API de Antecipação de Duplicatas para entidades cessionárias, sejam elas financiadoras ou não, em operações de antecipação de duplicatas de Risco Sacado e/ou Risco Cedente.

Endpoints do Financiador

Este endpoint permite consultar as operações direcionadas ao Cessionário. Ele retorna as informações das operações direciondas para o CESSIONÁRIO, agrupadas em uma lista encadeada por CEDENTE > OPERAÇÃO > DUPLICATA.

Tabela do Body JSON para consulta:

| **DESCRIÇÃO** | **CAMPO** | **OBRIGATÓRIO** | **INFORMAÇÃO** |
| --- | --- | --- | --- |
| **Filtro** | **filter** | \- | **\*Inicio seção consulta**\* |
| CPF/CNPJ Fornecedor | supplierCNPJ | N | CPF/CNPJ do Cedente |
| CPF/CNPJ Pagador | payerCNPJ | N | CPF/CNPJ do Sacado |
| Status Operação | operationStatus | N | 9 = DIRECIONADA  &lt;br>4 = APROVADA  &lt;br>8 = REPROVADA |
| **Data operação** | **operationDate** | \- | **\*Início range data de operação**\* |
| Data Inicio | begin | N | Data |
| Data Fim | end | N | Data |
| **Data operação** | \- | \- | **\*Fim range data de operação**\* |
| ID Operação | operationId | N | ID da operação gerada na solicitação |
| **Página** | **page** | \- | **\*Início range data de operação**\* |
| Itens por Página | pageSize | N | 25 até 100 |
| Nº da Página | pageNumber | N | 0 até 999999 |
| **Página** | \- | \- | **\*Fim range data de operação**\* |
| **Filtro** | \- | \- | **\*Fim seção consulta**\* |

**Observações**

- Caso nenhum campo seja preenchido, serão retornadas todas as operações com status de direcionadas ao CESSIONÁRIO na data corrente, limitadas a 25 itens apenas da página 1.
    

## Tabela do JSON retornado da consulta:

| **DESCRIÇÃO** | **CAMPO** | **EXEMPLO** |
| --- | --- | --- |
| **Seção** | \- | **\*Inicio seção operação**\* |
| Total de Páginas Disponiveis | totalPages | 10 |
| Nº de Operações por Página | numberOfElements | 50 |
| Nº Total de Operações | totalElements | 500 |
| **Lista** | \- | **\*Início da Lista de Operações**\* |
| ID da Operação | operationId | AL5123132132 |
| Origem da Operação | origin | CP = Contas a Pagar  &lt;br>CR = Contas a Receber |
| Modelo de Operação | operationModel | 1 = Com Regresso  &lt;br>2 = Sem Regresso |
| Modelo de Negócio | businessModel | 1 = Risco Sacado  &lt;br>2 = Risco Cedente |
| Data Operação | operationDate | 2023-05-29 |
| Data de Pagamento | paymentDate | 2023-05-29 |
| Valor Bruto Total (R$) | totalGrossAmount | 8552300 |
| Desagio Total (R$) | totalDiscountValue | 5236 |
| Valor Liquido Total (R$) | totalNetValue | 8425600 |
| Taxa ao Mês (%) | ratePerMonth | 249 |
| Tarifa da Operação (R$) | billingValue | 0 |
| Custo Efetivo Total (R$) | cet | 5236 |
| Comissão (%) | commission | 0 |
| Comissão (R$) | commissionValue | 0 |
| Status Operação | operationStatus | 9 = DIRECIONADA  &lt;br>4 = APROVADA  &lt;br>8 = REPROVADA |
| Status Assinatura do Termo de Cessão | statusAssignmentTerm | 1 = ASSINADO  &lt;br>2 = ASSINATURA(S) PENDENTE |
| **Fornecedor (Cedente)** | **supplier** | **\*Início seção Fornecedor**\* |
| Nº do cônvenio | covenant | 1200 |
| Razão Social | coporateName | xpto |
| Tipo de Registro | registrationType | CPF  &lt;br>CNPJ |
| Nº do Registro | registrationNumber | 12123123000101 |
| **Endereço Estabelecimento** | **address** | **\*Início seção Endereço**\* |
| Endereço | street | Rua Comercio |
| Número | number | 123 |
| Bairro | neighborhood | Bela Vista |
| CEP | zipCode | 05187030 |
| Ciedade | city | São Paulo |
| Estado | state | SP |
| **Endereço Estabelecimento** | \- | **\*Fim seção Endereço**\* |
| **Dados de Pagamento** | **operationPaymentAccount** | **\*Inicio seção de Pagamento**\* |
| Código do Banco | bankCode | 123 |
| Agência | agency | 321 |
| Conta | account | 123456 |
| **Dados de Pagamento** | \- | **\*Fim seção de Pagamento**\* |
| **Fornecedor (Cedente)** |  | **\*Fim seção Fornecedor**\* |
| **Detalhes da Operação** | **operationDetails** | **\*Início lista detalhes da operação**\* |
| **Nota Fiscal** | **invoice** | **\*Inicio seção Nota Fiscal**\* |
| Nº de Série | serie | 1 |
| Número | number | 1105 |
| Nº de Referência | referenceNumber | 1234545 |
| Valor Total (R$) | value | 1256400 |
| Data de Emissão | emissionDate | 2023-05-13 |
| Chave de Autenticação | key | 12345678912345678912345678912345678912345678 |
| **Duplicatas** | **duplicates** | **\*Início lista Duplicatas**\* |
| Número | number | 4787896 |
| Valor Total (R$) | value | 628200 |
| Vencimento | dueDate | 2023-05-29 |
| Pagamento | payment | 2023-05-29 |
| Prazo de Vencimento (Dias) | deadLineDays | 30 |
| Valor deságio | discountValue | 1200 |
| Valor Líquido | netValue | 627000 |
| **Duplicatas** | \- | **\*Fim lista Duplicatas**\* |
| **Pagador (Sacado)** | payer | **\*Início seção Pagador**\* |
| Convênio | covenant | 1200 |
| Nome / Razão Social | corporateName | xpto |
| Tipo de Registro | registrationType | CPF  &lt;br>CNPJ |
| Registro | registrationNumber | 12123456000120 |
| **Endereço Estabelecimento** | **address** | **\*Início seção Endereço**\* |
| Endereço | street | Rua Comercial |
| Número | number | 456 |
| Bairro | neighborhood | Bela Vista |
| CEP | zipCode | 05187020 |
| Cidade | city | São Paulo |
| Estado | state | SP |
| **Endereço Estabelecimento** | \- | **\*Fim seção Endereço**\* |
| **Pagador (Sacado)** | \- | **\*Fim seção Pagador**\* |
| **Nota Fiscal** | \- | **\*Fim seção Nota Fiscal**\* |
| **Detalhes da Operação** | \- | **\*Fim seção detalhes da operação**\* |
| **Lista** | \- | **\*Fim lista de operações**\* |
| **Seção** | \- | **\*Fim seção operação**\* |

Consultar operação

Endpoint para atualizar status das operações direcionadas para o Cessionário. Essa rora permite atualizar o status da operação para APROVADA ou REPROVADA.

Tabela do Body JSON para atualizar operação:

| **DESCRIÇÃO** | **CAMPO** | **OBRIGATÓRIO** | **INFORMAÇÃO** |
| --- | --- | --- | --- |
| **Seção** | \- | \- | **\*Início seção operação**\* |
| ID operaçao | operationId | S | ID da operação gerada |
| Status da Operação | payerCNPJ | S | 4 = APROVAR  &lt;br>8 = REPROVAR |
| Observação | observation | N | xpto |
| **Duplicata(s)** | **duplicates** | \- | **\*Início lista duplicatas**\* |
| Número | number | S | 4787896 |
| Valor Total (R$) | value | S | 628200 |
| Vencimento | dueDate | S | 2023-05-22 |
| Status | status | S | 1 = APROVAR  &lt;br>2 = REPROVAR |
| **Duplicata(s)** | \- | \- | **\*Fim lista duplicatas**\* |
| **Seção** | \- | \- | **\*Fim seção operação**\* |

Se a aprovação ou reprovação for solicitada, as seguintes mensagens podem ser retornadas:

- **200**: Sucesso
    

- **400**: ERRO AO APROVAR OPERAÇÃO: Ao aprovar uma operação, todas as duplicatas devem ter o STATUS = 1 (APROVAR).
    

- **400**: ERRO AO REPROVAR OPERAÇÃO: Ao reprovar uma operação, todas as duplicatas devem ter o STATUS = 2 (REPROVAR).
    

- **400**: ERRO AO APROVAR / REPROVAR OPERAÇÃO: Campo obrigatório não preenchido - "campo".
    

- **400**: ERRO AO APROVAR / REPROVAR OPERAÇÃO: A operação não pode ser reprovada, pois está com o status diferente de CADASTRADA. Status atual = "atual status".

Aprovar/Recusar operação

Endpoint para solicitar termo de cessão de operações. Essa rota recebe o termo de cessão atualizado da operação solicitada.

Tabela do Body JSON para solicitar termo de cessão:

| **DESCRIÇÃO** | **CAMPO** | **OBRIGATÓRIO** | **INFORMAÇÃO** |
| --- | --- | --- | --- |
| **Seção** | \- | \- | **\*Início seção operação**\* |
| ID operaçao | operationId | S | ID da operação gerada |
| **Seção** | \- | \- | **\*Fim seção operação**\* |

StartFragment

Se o termo de cessão for solicitado, as seguintes mensagens podem ser retornadas:

- **200**: Sucesso
    - PDF do termo de cessão será disponibilizado

- **404**: ID Operação não encontrada
    

- **404**: Operação não possui termo de cessão para download

Solicitar termo de cessão

API ANT. DUPLICATAS

Risco Sacado

Production

Pré produção

Para facilitar a implementação, descrevemos neste documento informações relevantes sobre nossas APis.

É um estilo de arquitetura que define um conjunto de restrições e propriedades baseados em HTTP.

Web Services que obedecem ao estilo arquitetural REST, ou Web Services RESTful, fornecem interoperabilidade entre sistemas. 

É um formato leve de troca de informações/dados entre sistemas, amplamente utilizado. 

Define um padrão de caracteres de comunicação entre sistemas distribuídos. 

Padrão utilizado para envio e retorno de campos do tipo data/hora. Esse padrão utiliza a Time Zone.

Nossas APIs seguem o padrão RESTful e utilizam o verbo HTTP referente a cada operação.

No momento da listagem de um recurso deve-se utilizar os parâmetros de paginação page e size.

Caso não seja informado nenhum valor o padrão será 

<p class="slate-p" placeholder="Type / for widgets">Descreve o fluxo básico para que um Investidor efetue a compra de uma operação na plataforma.</p><h2 class="slate-h2">Entenda o fluxo de compra pelo investidor</h2><ol class="slate-ol"><li class="slate-li"><div style="position:relative">As taxas e condições são configuradas na Veragi pela mesa de operações Accesstage</div></li><li class="slate-li"><div style="position:relative">Quando um cedente assina um termo de cessão, a API envia um webhook com as informações da operação, incluíndo dados do sacado, cedente, nota fiscal, duplicatas, valores e data da operação.</div></li><li class="slate-li"><div style="position:relative">O financiador faz uma requisição para a API aprovando ou recusando a a compra. Não é possível aceitar parcialmente uma operação.</div></li><li class="slate-li"><div style="position:relative">Se aceitar a operação, o investidor faz uma requisição para a API para recuperar o arquivo PDF do termo de cessão assinado.</div></li></ol><p class="slate-p" placeholder="Type / for widgets"></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1697224971323.png" alt="" id="1697224971340" width="536"/></div><h3 class="slate-h3">
</h3><p class="slate-p" placeholder="Type / for widgets"></p>

Descreve o fluxo básico para que um Investidor efetue a compra de uma operação na plataforma.

Entenda o fluxo de compra pelo investidor

<p class="slate-p" placeholder="Type / for widgets">Para agilizar a operação, a Veragi pode notificar o seu sistema através de webhook, informando uma nova operação.</p><h3 class="slate-h3">Como funciona o Webhook?</h3><ol class="slate-ol"><li class="slate-li"><div style="position:relative">O cliente informa uma url base para cadastrarmos na base de dados vinculada ao CNPJ do financiador.</div></li><li class="slate-li"><div style="position:relative">Este endpoint precisa estar configurado para receber a requisição com caminho /webhook/<span style="color:rgb(30, 83, 163)" class="slate-color">{ID_OPERACAO}</span>/<span style="color:rgb(182, 66, 76)" class="slate-color">{evento}</span>.</div></li><li class="slate-li"><div style="position:relative">A URL final montada pela Veragi ficará assim : <span style="color:rgb(43, 155, 98)" class="slate-color">{URL_BASE_DO_CLIENTE}</span>/webhook/<span style="color:rgb(30, 83, 163)" class="slate-color">{ID_OPERACAO}</span>/created
Ex: <a href="https://www.accesstage.com.br/financiador/webhook/ABC191023004376/created" target="_blank">https://www.accesstage.com.br/financiador/webhook/ABC191023004376/created</a></div></li><li class="slate-li"><div style="position:relative">Quando uma operação é criada a Veragi faz uma requisição HTTP para a URL configurada na plataforma. Veja o exemplo abaixo:</div></li></ol><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-18-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  &quot;operationId&quot;: &quot;FTESTE181023012141&quot;,
  &quot;operationModel&quot;: null,
  &quot;businessModel&quot;: null,
  &quot;operationDate&quot;: &quot;18/10/2023&quot;,
  &quot;paymentDate&quot;: &quot;18/10/2023&quot;,
  &quot;totalGrossAmount&quot;: &quot;1760000&quot;,
  &quot;totalDiscountValue&quot;: &quot;55287&quot;,
  &quot;totalNetValue&quot;: &quot;1704713&quot;,
  &quot;ratePerMonth&quot;: &quot;124&quot;,
  &quot;billingValue&quot;: &quot;55287&quot;,
  &quot;cet&quot;: &quot;1,53%&quot;,
  &quot;commission&quot;: &quot;000&quot;,
  &quot;commissionValue&quot;: &quot;000&quot;,
  &quot;operationStatus&quot;: 4,
  &quot;statusAssignmentTerm&quot;: 1,</div><div class="slate-code_line">    &quot;supplier&quot;: {</div><div class="slate-code_line">        &quot;covenant&quot;: null,</div><div class="slate-code_line">        &quot;corporateName&quot;: &quot;RAZAO SOCIAL LTDA&quot;,</div><div class="slate-code_line">        &quot;registrationType&quot;: &quot;2&quot;,</div><div class="slate-code_line">        &quot;registrationNumber&quot;: &quot;11987245000115&quot;,</div><div class="slate-code_line">        &quot;address&quot;: {</div><div class="slate-code_line">            &quot;street&quot;: &quot;RUA ANTONIO GENTIL&quot;,</div><div class="slate-code_line">            &quot;number&quot;: &quot;606&quot;,</div><div class="slate-code_line">            &quot;neighborhood&quot;: &quot;VILA LUIZ BARON&quot;,</div><div class="slate-code_line">            &quot;zipCode&quot;: &quot;83412-030&quot;,</div><div class="slate-code_line">            &quot;city&quot;: &quot;Colombo&quot;,</div><div class="slate-code_line">            &quot;state&quot;: &quot;PR&quot;</div><div class="slate-code_line">        },</div><div class="slate-code_line">        &quot;operationPaymentAccount&quot;: {</div><div class="slate-code_line">            &quot;bankCode&quot;: &quot;001&quot;,</div><div class="slate-code_line">            &quot;agency&quot;: &quot;3141&quot;,</div><div class="slate-code_line">            &quot;account&quot;: &quot;1168857&quot;</div><div class="slate-code_line">        }</div><div class="slate-code_line">    },</div><div class="slate-code_line">    &quot;operationDetails&quot;: [</div><div class="slate-code_line">        {</div><div class="slate-code_line">            &quot;invoice&quot;: {</div><div class="slate-code_line">                &quot;serie&quot;: &quot;006&quot;,</div><div class="slate-code_line">                &quot;number&quot;: &quot;012396030&quot;,</div><div class="slate-code_line">                &quot;referenceNumber&quot;: &quot;0000000123456&quot;,</div><div class="slate-code_line">                &quot;value&quot;: &quot;1760000&quot;,</div><div class="slate-code_line">                &quot;emissionDate&quot;: &quot;20082022&quot;,</div><div class="slate-code_line">                &quot;key&quot;: &quot;00000000000000000012843794038978383928173901&quot;,</div><div class="slate-code_line">                &quot;duplicates&quot;: [</div><div class="slate-code_line">                    {</div><div class="slate-code_line">                        &quot;number&quot;: &quot;012396030-016&quot;,</div><div class="slate-code_line">                        &quot;value&quot;: &quot;1760000&quot;,</div><div class="slate-code_line">                        &quot;dueDate&quot;: &quot;31122023&quot;,</div><div class="slate-code_line">                        &quot;paymentDate&quot;: &quot;02012024&quot;,</div><div class="slate-code_line">                        &quot;deadlineDays&quot;: 88,</div><div class="slate-code_line">                        &quot;discountValue&quot;: &quot;103253&quot;,</div><div class="slate-code_line">                        &quot;netValue&quot;: &quot;1644474&quot;</div><div class="slate-code_line">                    }</div><div class="slate-code_line">                ],</div><div class="slate-code_line">                &quot;payer&quot;: {</div><div class="slate-code_line">                    &quot;covenant&quot;: &quot;34/2023&quot;,</div><div class="slate-code_line">                    &quot;corporateName&quot;: &quot;Raao social S.A&quot;,</div><div class="slate-code_line">                    &quot;registrationType&quot;: &quot;2&quot;,</div><div class="slate-code_line">                    &quot;registrationNumber&quot;: &quot;11987245000115&quot;,</div><div class="slate-code_line">                    &quot;address&quot;: {</div><div class="slate-code_line">                        &quot;street&quot;: &quot;Av Esmeralda&quot;,</div><div class="slate-code_line">                        &quot;number&quot;: &quot;1300&quot;,</div><div class="slate-code_line">                        &quot;neighborhood&quot;: &quot;Borda do Campo&quot;,</div><div class="slate-code_line">                        &quot;zipCode&quot;: &quot;83170-900&quot;,</div><div class="slate-code_line">                        &quot;city&quot;: &quot;S dos Pinhais&quot;,</div><div class="slate-code_line">                        &quot;state&quot;: &quot;PR&quot;</div><div class="slate-code_line"></div><div class="slate-code_line">                    }</div><div class="slate-code_line">                }</div><div class="slate-code_line">            }</div><div class="slate-code_line">        }</div><div class="slate-code_line">    ]</div><div class="slate-code_line">}</div></code></pre><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Para agilizar a operação, a Veragi pode notificar o seu sistema através de webhook, informando uma nova operação.

<p class="slate-p" placeholder="Type / for widgets">A autenticação utilizada nesta API é baseada no protocolo OAuth 2.0. </p><p class="slate-p" placeholder="Type / for widgets">Para obter as credenciais de acesso, entre em contato conosco, pelos canais de atendimento Accesstage.</p><h3 class="slate-h3">Gerando o token de autenticação</h3><p class="slate-p" placeholder="Type / for widgets">Após a criação do seu Usuário e do seu Client de API você conseguirá obter o token de autenticação, ele é necessário para todas as chamadas de API.</p><p class="slate-p" placeholder="Type / for widgets">Para conseguir o token de autenticação você deve realizar uma requisição da seguinte forma:</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Exemplo de resposta:</strong></p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-170-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{
    &quot;AuthenticationResult&quot;: {
        &quot;AccessToken&quot;: &quot;eyJraWQiOiJnTkYwVVUxZ0Z1MWJVc2pCS2xoc0pVS0N3Z2t0dVlrNUVYV2g1TFA4T3M4PSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiIxN2M3MTg1Ni1lMjVmLTQxMDQtOWIwNi00MmRmMjc1ZWVmNjciLCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAudXMtZWFzdC0xLmFtYXpvbmF3cy5jb21cL3VzLWVhc3QtMV9HSTVtUGoxeHoiLCJjbGllbnRfaWQiOiIzYzdxNnFtcWIzMGtoZnRldGkwZjVoNWhpbiIsIm9yaWdpbl9qdGkiOiI2ZGQ2ZjUxZC04MWQ5LTQ1ZTMtOGJhNi1kMmExZThlYzdkMTYiLCJldmVudF9pZCI6IjEwZGJmYmE4LTZlMzQtNDcyNC04MzM5LWYwNWZlYWExMzEwNiIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiYXdzLmNvZ25pdG8uc2lnbmluLnVzZXIuYWRtaW4iLCJhdXRoX3RpbWUiOjE2OTcyMjM3ODYsImV4cCI6MTY5NzIyNzM4NiwiaWF0IjoxNjk3MjIzNzg2LCJqdGkiOiIwMzRiZDg3Yi0xNDY5LTQ2OTUtYjllOS1lZmU2NmM0NTQ1MTQiLCJ1c2VybmFtZSI6InNlcnZpY2VAZmluYXRlc3RlIn0.H9C9zb1b3Nxb0523NDVvaR_vnsMEI7y2U1jQFntzeV0y-va5iIsY-0d4a_x4SN2zL5wCHP0AtokJeVBYomtlfaeuXA1qWgT7TrB4OnrjG8R_bOk6bMPs7yP5WSwF3BQPDbQNCxhZMtYkMN4D8dQYnJNp4gc03_wqnxaU2w-bylQuxEkpSFhLAKYh8ephpf6LVsCM6XrrU4bBs84drrMSetWfvFUOlhdcy2mFwkK56GqXAHtiaAgq-PLFb13J7S9TQV7TQeBZsjRLv5A_6P9Dk9UqgFLNQ-Lmko-2lD9y3ws1eB_KfsjLWs5Q_omSjpqe558IVVnOAfkfePLkFqOmhA&quot;,
        &quot;ExpiresIn&quot;: 3600,
        &quot;IdToken&quot;: &quot;eyJraWQiOiI1UTdTT01pZnBVU09xOTE1NXJBbE5NdWRRUkNsQzEwaCtDZ0hNUGkrUVlrPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiIxN2M3MTg1Ni1lMjVmLTQxMDQtOWIwNi00MmRmMjc1ZWVmNjciLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC51cy1lYXN0LTEuYW1hem9uYXdzLmNvbVwvdXMtZWFzdC0xX0dJNW1QajF4eiIsInBob25lX251bWJlcl92ZXJpZmllZCI6ZmFsc2UsImNvZ25pdG86dXNlcm5hbWUiOiJzZXJ2aWNlQGZpbmF0ZXN0ZSIsImN1c3RvbTp1c2VySWQiOiI0NTk2NCIsIm9yaWdpbl9qdGkiOiI2ZGQ2ZjUxZC04MWQ5LTQ1ZTMtOGJhNi1kMmExZThlYzdkMTYiLCJhdWQiOiIzYzdxNnFtcWIzMGtoZnRldGkwZjVoNWhpbiIsImV2ZW50X2lkIjoiMTBkYmZiYTgtNmUzNC00NzI0LTgzMzktZjA1ZmVhYTEzMTA2IiwidG9rZW5fdXNlIjoiaWQiLCJhdXRoX3RpbWUiOjE2OTcyMjM3ODYsInBob25lX251bWJlciI6Iis1NTk5OTk5OTk5OTk5IiwiZXhwIjoxNjk3MjI3Mzg2LCJpYXQiOjE2OTcyMjM3ODYsImp0aSI6IjA5MDgyOWVkLTk1OGYtNDhkMi04YjZlLWExYjkwZWU1MmMxZCIsImVtYWlsIjoiYXBpQGFjY2Vzc3RhZ2UuY29tLmJyIn0.KXMpy2Eh5EzTUctAcR2zqn7wzSeEAOJ9v-9YmYpkh5vKaZ9eHzuC6ErinUibiOhoxELC2w1W7Lag58H7BhgUuKqJaTf53cMk62AJOXolw7VoFUltJgXr0ILPVn9LkjJuVHCKTk0kYR5QRZDznXaN2qdnxg0nq5RxMOaHWE6s9xRdyAIy1pw23qM8DYo5IQsBMFHnjstEl1pU5hdglqLe0DOKUKh1TXx2tGE6eWZOpMSjFPVwixsiFCWqW-LWmDCFsGG9kap6MOdyACDA4rygFzYDfnDzIUDlFIw0P_Jw-xu40qlUb59IG0LHIZoHzAMmNw72ZrQHKkGMybPrNkfCBQ&quot;,
        &quot;RefreshToken&quot;: &quot;eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ.d5WD2iQ3jJn2EHazQLyp8NNv8Ww_OfkgUpkiU2bK3RUz03WeCbs3xvvV3gMrJR8CV-_097PCp5kG0wZ-iYcAlTAk2f3ROb-4-oSgXBhRs_qA-qqg-DTMbdFI9Zk_RHiNS1E7cCG78wgU-SU5Py157z6XT6Mj4dlKAMDOAYfOlMOjeuNVIufr4N3pqrDGhnDfX-P-902zXK0AeGorqE6C3zapJP-XqrCp49R6IkQjdcjy6LWwMYDBHGwzeGKgv3WnPLpQ10k-G4wk0FP5l1dBv1VB00fhHwGBO9h7vsDRlUzhYjwTYUO83L62ygif7s-EB8KYuwxIEiG25tLptJjqGg.YhWMBkFM5Z73iN8d.-rvNN8GwyHKUbZU4bmLq-5P5aFKfzHP3a9amLHMc8afEKshGm8Kyux1bf3E5XW9yxtLQE-hACyOVG3f5wFJSl8DsxXu_IhNKLY8BUOvPP3D1SZUJrMDAMGvudOz2UloiQoz76LOAxglNDfCDGBCO_iEDoFG3oOLfdTjMTUDJNNcN8busB1Fp9MjHQSLXd2-bGLJ-4xGuaUr3ghrOTT95f_l1Og9EjpwLIz_GAtpuh4pZaElYUlToAiNZmugsO7THZ3ikTP5cUaZo5yAb-QjZqrodifrI4hC08l9ctddG3_q45T7zOuehkUIJa43JZ2oA_EeCvbn-6pdMBheD8ubluDrlo9bQzA0Z2-QfHa8WMsY62Z1I1prxkDtmU8TmFYH3pxfoaCS8zzK90hHacOcd24W0l2Ep7zlTBY-6vPMkoijN58JaJoLz8dF-5aWOxngvtSffal2zvFSSvoh8s1m3KOzWCUhKWMAuaQz7P5suTFy4gl023yIx5-um-tjO0u4Mpg7MES1KPSRMLDlmY_0rN7RdNvpP0oZykO-VnZVgYwQF2g00NhmFQ5ec4zvXOe0mOaiOuZckERfimy-_RIF8naiD_fdyOYY0eNQZ-cO4HW2wAx4RrgAI1qDudbE97rZOf3ADQyvFFS4Pdfq5nBvT0wDwhEicj1xmIXkoRJvsOZ47svdVp9L3TBGlTbF9Ty_8RrFsqtZLvTcWXenS-RYg_SKXzZApjdS70dxIpW449D-od_rYEXTFJo0jQw--HNsf-VIu5GQKlBv7bGYoS6J9gNcjecvgsujLQ1i81D3QZk6l0su1gS77SEPLPc6dbHsl3mqbPpWlyiXE31VUE-6pH0DmmmZK0ImaSvOIDD0vqNOCaFHLDL6JE1h5FM_MujkqUc85hZNDvhgziduixR8I68gwikobDdAIkyU_-f4m0f-qDmBczGTXxBh_d48Pf53HiZQlNYX-yFKOiUCZWyuj2VoAIt-yupz-e3WQNAJPMocuabmcs6iimLcyjYBnPe_f38Na5VXlsHp74X4FCyhuzNGsY8otcDNouyLu7BKK-t3Hnx2RtOC5S3-P92AJ16gfv8Fr7Y91ECiuLB6mS_jyPsxqrd40ygptXTJs7sTBD6Odv-abqp9LC8Z1m6weYXbXbDHqMiveali3ndd0gJjItRnlpDzrlpgfvQ380XmXql4r5LLf0tee34f1dkIOgRKrHQDyUp8C2_kGFwGf8x5LFQkHW9bJR0LsZCLL6BIObCYGbCY_Q4IcnO_4uOHim446roby85hFum4zV1gImH17tIdRRw.4zquL8soOlV2fPuH8bRXWg&quot;,
        &quot;TokenType&quot;: &quot;bearer&quot;
    },
    &quot;ChallengeParameters&quot;: {}
}</div></code></pre><p class="slate-p" placeholder="Type / for widgets"></p>

A autenticação utilizada nesta API é baseada no protocolo OAuth 2.0. 

Para obter as credenciais de acesso, entre em contato conosco, pelos canais de atendimento Accesstage.

Após a criação do seu Usuário e do seu Client de API você conseguirá obter o token de autenticação, ele é necessário para todas as chamadas de API.

Para conseguir o token de autenticação você deve realizar uma requisição da seguinte forma:

AuthParameters

Content-Type

Connection

<h2 class="slate-h2">Apresentação</h2><p class="slate-p" placeholder="Type / for widgets">Esta documentação descreve a integração com a API de Antecipação de Duplicatas para entidades cessionárias (financiadores), sejam elas financiadoras ou não, em operações de antecipação de duplicatas de Risco Sacado e/ou Risco Cedente.</p><p class="slate-p" placeholder="Type / for widgets"></p>

Esta documentação descreve a integração com a API de Antecipação de Duplicatas para entidades cessionárias (financiadores), sejam elas financiadoras ou não, em operações de antecipação de duplicatas de Risco Sacado e/ou Risco Cedente.

Este endpoint permite consultar as operações direcionadas ao Cessionário. Ele retorna as informações das operações direciondas para o CESSIONÁRIO, agrupadas em uma lista encadeada por CEDENTE > OPERAÇÃO > DUPLICATA.

filter

page

timestamp

status

error

path

Endpoint para atualizar status das operações direcionadas para o Cessionário. Essa rota permite atualizar o status da operação para APROVADA ou REPROVADA.

Tabela do Body JSON para atualizar operação:

Se a aprovação ou reprovação for solicitada, as seguintes mensagens podem ser retornadas:

operationId

operationStatus

duplicates

<p class="slate-p" placeholder="Type / for widgets">Endpoint para solicitar termo de cessão de operações. Essa rota recebe o termo de cessão atualizado da operação solicitada.</p><p class="slate-p" placeholder="Type / for widgets">Tabela do Body JSON para solicitar termo de cessão:</p><table class="slate-table"><colgroup></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">DESCRIÇÃO</strong></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">CAMPO</strong></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">OBRIGATÓRIO</strong></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">INFORMAÇÃO</strong></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">Seção</strong></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">-</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">-</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">*Início seção operação</strong>*</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">ID operaçao</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">operationId</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">S</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">ID da operação gerada</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">Seção</strong></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">-</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">-</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">*Fim seção operação</strong>*</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><p class="slate-p" placeholder="Type / for widgets">StartFragment</p><p class="slate-p" placeholder="Type / for widgets">Se o termo de cessão for solicitado, as seguintes mensagens podem ser retornadas:</p><ul class="slate-ul"><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">200</strong>: Sucesso</p><ul class="slate-ul"><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets">PDF do termo de cessão será disponibilizado</p></li></ul></li><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">404</strong>: ID Operação não encontrada</p></li><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">404</strong>: Operação não possui termo de cessão para download</p></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Endpoint para solicitar termo de cessão de operações. Essa rota recebe o termo de cessão atualizado da operação solicitada.

Tabela do Body JSON para solicitar termo de cessão:

Se o termo de cessão for solicitado, as seguintes mensagens podem ser retornadas:

Sections