POST api/Intimacao/AdicionarCartaParaCancelamento

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InformacoesCartaParaCancelamento	CartaParaCancelamentoApi	None.
AppID	globally unique identifier	Required
PedidoID	globally unique identifier	Required

Request Formats

application/json, text/json

Sample:

{
  "InformacoesCartaParaCancelamento": {
    "DadosDoCartorio": {
      "Codigo": 1,
      "Nome": "sample string 2",
      "TipoDeDocumento": "sample string 3",
      "NumeroDoDocumento": 4,
      "Endereco": {
        "CEP": 1,
        "Endereco": "sample string 2",
        "NumeroDoEndereco": "sample string 3",
        "Complemento": "sample string 4",
        "Bairro": "sample string 5",
        "Cidade": "sample string 6",
        "Estado": "sample string 7",
        "Ordem": 8
      },
      "Telefones": "sample string 5",
      "Emails": "sample string 6",
      "HorarioDeFuncionamento": "sample string 7",
      "Site": "sample string 8"
    },
    "DadosDoTitulo": [
      {
        "NumeroDoProtocolo": 1,
        "DataDoProtocolo": "2025-12-06T00:44:51.9994324-03:00",
        "CodigoDeBarras": "sample string 3",
        "TipoDoProtesto": "sample string 4",
        "PrazoLimite": "2025-12-06T00:44:51.9994324-03:00",
        "SiglaDaEspecie": "sample string 6",
        "DescricaoDaEspecie": "sample string 7",
        "NumeroDoTitulo": "sample string 8",
        "DataDaEmissao": "2025-12-06T00:44:51.9994324-03:00",
        "DataDoVencimento": "2025-12-06T00:44:51.9994324-03:00",
        "DescricaoDoVencimento": "sample string 10",
        "Endosso": "sample string 11",
        "ValorOriginal": 12.0,
        "ValorAProtestar": 13.0,
        "ChaveUnica": "sample string 14",
        "ProtestoComDireitoDeRegresso": true,
        "TipoDaDivida": "sample string 16",
        "IdentificacaoDaDivida": "sample string 17",
        "Origem": "sample string 18",
        "DadosDosApresentantes": [
          {
            "Nome": "sample string 1",
            "TipoDeDocumento": "sample string 2",
            "NumeroDoDocumento": 3,
            "CodigoDoApresentante": "sample string 4",
            "Qualificacao": "sample string 5",
            "Endereco": {
              "CEP": 1,
              "Endereco": "sample string 2",
              "NumeroDoEndereco": "sample string 3",
              "Complemento": "sample string 4",
              "Bairro": "sample string 5",
              "Cidade": "sample string 6",
              "Estado": "sample string 7",
              "Ordem": 8
            }
          },
          {
            "Nome": "sample string 1",
            "TipoDeDocumento": "sample string 2",
            "NumeroDoDocumento": 3,
            "CodigoDoApresentante": "sample string 4",
            "Qualificacao": "sample string 5",
            "Endereco": {
              "CEP": 1,
              "Endereco": "sample string 2",
              "NumeroDoEndereco": "sample string 3",
              "Complemento": "sample string 4",
              "Bairro": "sample string 5",
              "Cidade": "sample string 6",
              "Estado": "sample string 7",
              "Ordem": 8
            }
          }
        ],
        "Sacador": {
          "Nome": "sample string 1",
          "TipoDeDocumento": "sample string 2",
          "NumeroDoDocumento": 3,
          "Qualificacao": "sample string 4",
          "Endereco": {
            "CEP": 1,
            "Endereco": "sample string 2",
            "NumeroDoEndereco": "sample string 3",
            "Complemento": "sample string 4",
            "Bairro": "sample string 5",
            "Cidade": "sample string 6",
            "Estado": "sample string 7",
            "Ordem": 8
          }
        },
        "ValorParaCancelamento": 19.0,
        "CustasParaCancelamento": 20.0,
        "VencimentoID": "5b27c424-c052-48bd-ab6c-e11183557961"
      },
      {
        "NumeroDoProtocolo": 1,
        "DataDoProtocolo": "2025-12-06T00:44:51.9994324-03:00",
        "CodigoDeBarras": "sample string 3",
        "TipoDoProtesto": "sample string 4",
        "PrazoLimite": "2025-12-06T00:44:51.9994324-03:00",
        "SiglaDaEspecie": "sample string 6",
        "DescricaoDaEspecie": "sample string 7",
        "NumeroDoTitulo": "sample string 8",
        "DataDaEmissao": "2025-12-06T00:44:51.9994324-03:00",
        "DataDoVencimento": "2025-12-06T00:44:51.9994324-03:00",
        "DescricaoDoVencimento": "sample string 10",
        "Endosso": "sample string 11",
        "ValorOriginal": 12.0,
        "ValorAProtestar": 13.0,
        "ChaveUnica": "sample string 14",
        "ProtestoComDireitoDeRegresso": true,
        "TipoDaDivida": "sample string 16",
        "IdentificacaoDaDivida": "sample string 17",
        "Origem": "sample string 18",
        "DadosDosApresentantes": [
          {
            "Nome": "sample string 1",
            "TipoDeDocumento": "sample string 2",
            "NumeroDoDocumento": 3,
            "CodigoDoApresentante": "sample string 4",
            "Qualificacao": "sample string 5",
            "Endereco": {
              "CEP": 1,
              "Endereco": "sample string 2",
              "NumeroDoEndereco": "sample string 3",
              "Complemento": "sample string 4",
              "Bairro": "sample string 5",
              "Cidade": "sample string 6",
              "Estado": "sample string 7",
              "Ordem": 8
            }
          },
          {
            "Nome": "sample string 1",
            "TipoDeDocumento": "sample string 2",
            "NumeroDoDocumento": 3,
            "CodigoDoApresentante": "sample string 4",
            "Qualificacao": "sample string 5",
            "Endereco": {
              "CEP": 1,
              "Endereco": "sample string 2",
              "NumeroDoEndereco": "sample string 3",
              "Complemento": "sample string 4",
              "Bairro": "sample string 5",
              "Cidade": "sample string 6",
              "Estado": "sample string 7",
              "Ordem": 8
            }
          }
        ],
        "Sacador": {
          "Nome": "sample string 1",
          "TipoDeDocumento": "sample string 2",
          "NumeroDoDocumento": 3,
          "Qualificacao": "sample string 4",
          "Endereco": {
            "CEP": 1,
            "Endereco": "sample string 2",
            "NumeroDoEndereco": "sample string 3",
            "Complemento": "sample string 4",
            "Bairro": "sample string 5",
            "Cidade": "sample string 6",
            "Estado": "sample string 7",
            "Ordem": 8
          }
        },
        "ValorParaCancelamento": 19.0,
        "CustasParaCancelamento": 20.0,
        "VencimentoID": "5b27c424-c052-48bd-ab6c-e11183557961"
      }
    ],
    "DadosDoBoleto": {
      "CodigoDoBanco": 1,
      "DigitoDoBanco": "sample string 2",
      "LinhaDigitavel": "sample string 3",
      "CodigoDeBarras": "sample string 4",
      "NomeDoBanco": "sample string 5",
      "DataDeVencimento": "2025-12-06T00:44:51.9994324-03:00",
      "DataDeEmissao": "2025-12-06T00:44:51.9994324-03:00",
      "Agencia": "sample string 8",
      "NumeroDoContrato": "sample string 9",
      "NumeroDaConta": "sample string 10",
      "DigitoDaConta": "sample string 11",
      "NumeroDoDocumento": "sample string 12",
      "Especie": "sample string 13",
      "Carteira": "sample string 14",
      "NossoNumero": "sample string 15",
      "DigitoNossoNumero": "sample string 16",
      "ValorJuros": 17.0,
      "ValorMulta": 18.0,
      "ValorDesconto": 19.0,
      "OutrosAcrescimos": 20.0,
      "ValorDoBoleto": 21.0,
      "Instrucoes": "sample string 22",
      "CodigoDoBeneficiario": "sample string 23",
      "NossoNumeroParaExibicao": "sample string 24",
      "LogoDoBanco": "QEA=",
      "QrCodePagamento": "sample string 25",
      "LinkDePagamento": "sample string 26"
    },
    "DadosDoDestinatario": {
      "Nome": "sample string 1",
      "TipoDeDocumento": "sample string 2",
      "NumeroDoDocumento": 3,
      "Qualificacao": "sample string 4",
      "Endereco": {
        "CEP": 1,
        "Endereco": "sample string 2",
        "NumeroDoEndereco": "sample string 3",
        "Complemento": "sample string 4",
        "Bairro": "sample string 5",
        "Cidade": "sample string 6",
        "Estado": "sample string 7",
        "Ordem": 8
      }
    },
    "ApontamentoIntimacaoDataDoProtocolo": "sample string 1",
    "ApontamentoIntimacaoNumeroDoProtocolo": "sample string 2",
    "CodigoDeBarrasDaCartaParaCancelamento": "sample string 3",
    "DataParaDistribuicao": "2025-12-06T00:44:51.9994324-03:00"
  },
  "AppID": "7a82a051-b750-4801-9d44-22ab19170d98",
  "PedidoID": "4dd33657-8f41-466b-bd14-f51290f59ab8"
}

application/xml, text/xml

Sample:

<CartaParaCancelamentoRequestApi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/rift.logistica.model.Api">
  <AppID>7a82a051-b750-4801-9d44-22ab19170d98</AppID>
  <InformacoesCartaParaCancelamento>
    <ApontamentoIntimacaoDataDoProtocolo>sample string 1</ApontamentoIntimacaoDataDoProtocolo>
    <ApontamentoIntimacaoNumeroDoProtocolo>sample string 2</ApontamentoIntimacaoNumeroDoProtocolo>
    <CodigoDeBarrasDaCartaParaCancelamento>sample string 3</CodigoDeBarrasDaCartaParaCancelamento>
    <DadosDoBoleto>
      <Agencia>sample string 8</Agencia>
      <Carteira>sample string 14</Carteira>
      <CodigoDeBarras>sample string 4</CodigoDeBarras>
      <CodigoDoBanco>1</CodigoDoBanco>
      <CodigoDoBeneficiario>sample string 23</CodigoDoBeneficiario>
      <DataDeEmissao>2025-12-06T00:44:51.9994324-03:00</DataDeEmissao>
      <DataDeVencimento>2025-12-06T00:44:51.9994324-03:00</DataDeVencimento>
      <DigitoDaConta>sample string 11</DigitoDaConta>
      <DigitoDoBanco>sample string 2</DigitoDoBanco>
      <DigitoNossoNumero>sample string 16</DigitoNossoNumero>
      <Especie>sample string 13</Especie>
      <Instrucoes>sample string 22</Instrucoes>
      <LinhaDigitavel>sample string 3</LinhaDigitavel>
      <LinkDePagamento>sample string 26</LinkDePagamento>
      <LogoDoBanco>QEA=</LogoDoBanco>
      <NomeDoBanco>sample string 5</NomeDoBanco>
      <NossoNumero>sample string 15</NossoNumero>
      <NossoNumeroParaExibicao>sample string 24</NossoNumeroParaExibicao>
      <NumeroDaConta>sample string 10</NumeroDaConta>
      <NumeroDoContrato>sample string 9</NumeroDoContrato>
      <NumeroDoDocumento>sample string 12</NumeroDoDocumento>
      <OutrosAcrescimos>20</OutrosAcrescimos>
      <QrCodePagamento>sample string 25</QrCodePagamento>
      <ValorDesconto>19</ValorDesconto>
      <ValorDoBoleto>21</ValorDoBoleto>
      <ValorJuros>17</ValorJuros>
      <ValorMulta>18</ValorMulta>
    </DadosDoBoleto>
    <DadosDoCartorio>
      <Codigo>1</Codigo>
      <Emails>sample string 6</Emails>
      <Endereco>
        <Bairro>sample string 5</Bairro>
        <CEP>1</CEP>
        <Cidade>sample string 6</Cidade>
        <Complemento>sample string 4</Complemento>
        <Endereco>sample string 2</Endereco>
        <Estado>sample string 7</Estado>
        <NumeroDoEndereco>sample string 3</NumeroDoEndereco>
        <Ordem>8</Ordem>
      </Endereco>
      <HorarioDeFuncionamento>sample string 7</HorarioDeFuncionamento>
      <Nome>sample string 2</Nome>
      <NumeroDoDocumento>4</NumeroDoDocumento>
      <Site>sample string 8</Site>
      <Telefones>sample string 5</Telefones>
      <TipoDeDocumento>sample string 3</TipoDeDocumento>
    </DadosDoCartorio>
    <DadosDoDestinatario>
      <Endereco>
        <Bairro>sample string 5</Bairro>
        <CEP>1</CEP>
        <Cidade>sample string 6</Cidade>
        <Complemento>sample string 4</Complemento>
        <Endereco>sample string 2</Endereco>
        <Estado>sample string 7</Estado>
        <NumeroDoEndereco>sample string 3</NumeroDoEndereco>
        <Ordem>8</Ordem>
      </Endereco>
      <Nome>sample string 1</Nome>
      <NumeroDoDocumento>3</NumeroDoDocumento>
      <Qualificacao>sample string 4</Qualificacao>
      <TipoDeDocumento>sample string 2</TipoDeDocumento>
    </DadosDoDestinatario>
    <DadosDoTitulo>
      <CartaApiDadosDoTitulo>
        <ChaveUnica>sample string 14</ChaveUnica>
        <CodigoDeBarras>sample string 3</CodigoDeBarras>
        <CustasParaCancelamento>20</CustasParaCancelamento>
        <DadosDosApresentantes>
          <CartaApiDadosDoApresentante>
            <CodigoDoApresentante>sample string 4</CodigoDoApresentante>
            <Endereco>
              <Bairro>sample string 5</Bairro>
              <CEP>1</CEP>
              <Cidade>sample string 6</Cidade>
              <Complemento>sample string 4</Complemento>
              <Endereco>sample string 2</Endereco>
              <Estado>sample string 7</Estado>
              <NumeroDoEndereco>sample string 3</NumeroDoEndereco>
              <Ordem>8</Ordem>
            </Endereco>
            <Nome>sample string 1</Nome>
            <NumeroDoDocumento>3</NumeroDoDocumento>
            <Qualificacao>sample string 5</Qualificacao>
            <TipoDeDocumento>sample string 2</TipoDeDocumento>
          </CartaApiDadosDoApresentante>
          <CartaApiDadosDoApresentante>
            <CodigoDoApresentante>sample string 4</CodigoDoApresentante>
            <Endereco>
              <Bairro>sample string 5</Bairro>
              <CEP>1</CEP>
              <Cidade>sample string 6</Cidade>
              <Complemento>sample string 4</Complemento>
              <Endereco>sample string 2</Endereco>
              <Estado>sample string 7</Estado>
              <NumeroDoEndereco>sample string 3</NumeroDoEndereco>
              <Ordem>8</Ordem>
            </Endereco>
            <Nome>sample string 1</Nome>
            <NumeroDoDocumento>3</NumeroDoDocumento>
            <Qualificacao>sample string 5</Qualificacao>
            <TipoDeDocumento>sample string 2</TipoDeDocumento>
          </CartaApiDadosDoApresentante>
        </DadosDosApresentantes>
        <DataDaEmissao>2025-12-06T00:44:51.9994324-03:00</DataDaEmissao>
        <DataDoProtocolo>2025-12-06T00:44:51.9994324-03:00</DataDoProtocolo>
        <DataDoVencimento>2025-12-06T00:44:51.9994324-03:00</DataDoVencimento>
        <DescricaoDaEspecie>sample string 7</DescricaoDaEspecie>
        <DescricaoDoVencimento>sample string 10</DescricaoDoVencimento>
        <Endosso>sample string 11</Endosso>
        <IdentificacaoDaDivida>sample string 17</IdentificacaoDaDivida>
        <NumeroDoProtocolo>1</NumeroDoProtocolo>
        <NumeroDoTitulo>sample string 8</NumeroDoTitulo>
        <Origem>sample string 18</Origem>
        <PrazoLimite>2025-12-06T00:44:51.9994324-03:00</PrazoLimite>
        <ProtestoComDireitoDeRegresso>true</ProtestoComDireitoDeRegresso>
        <Sacador>
          <Endereco>
            <Bairro>sample string 5</Bairro>
            <CEP>1</CEP>
            <Cidade>sample string 6</Cidade>
            <Complemento>sample string 4</Complemento>
            <Endereco>sample string 2</Endereco>
            <Estado>sample string 7</Estado>
            <NumeroDoEndereco>sample string 3</NumeroDoEndereco>
            <Ordem>8</Ordem>
          </Endereco>
          <Nome>sample string 1</Nome>
          <NumeroDoDocumento>3</NumeroDoDocumento>
          <Qualificacao>sample string 4</Qualificacao>
          <TipoDeDocumento>sample string 2</TipoDeDocumento>
        </Sacador>
        <SiglaDaEspecie>sample string 6</SiglaDaEspecie>
        <TipoDaDivida>sample string 16</TipoDaDivida>
        <TipoDoProtesto>sample string 4</TipoDoProtesto>
        <ValorAProtestar>13</ValorAProtestar>
        <ValorOriginal>12</ValorOriginal>
        <ValorParaCancelamento>19</ValorParaCancelamento>
        <VencimentoID>5b27c424-c052-48bd-ab6c-e11183557961</VencimentoID>
      </CartaApiDadosDoTitulo>
      <CartaApiDadosDoTitulo>
        <ChaveUnica>sample string 14</ChaveUnica>
        <CodigoDeBarras>sample string 3</CodigoDeBarras>
        <CustasParaCancelamento>20</CustasParaCancelamento>
        <DadosDosApresentantes>
          <CartaApiDadosDoApresentante>
            <CodigoDoApresentante>sample string 4</CodigoDoApresentante>
            <Endereco>
              <Bairro>sample string 5</Bairro>
              <CEP>1</CEP>
              <Cidade>sample string 6</Cidade>
              <Complemento>sample string 4</Complemento>
              <Endereco>sample string 2</Endereco>
              <Estado>sample string 7</Estado>
              <NumeroDoEndereco>sample string 3</NumeroDoEndereco>
              <Ordem>8</Ordem>
            </Endereco>
            <Nome>sample string 1</Nome>
            <NumeroDoDocumento>3</NumeroDoDocumento>
            <Qualificacao>sample string 5</Qualificacao>
            <TipoDeDocumento>sample string 2</TipoDeDocumento>
          </CartaApiDadosDoApresentante>
          <CartaApiDadosDoApresentante>
            <CodigoDoApresentante>sample string 4</CodigoDoApresentante>
            <Endereco>
              <Bairro>sample string 5</Bairro>
              <CEP>1</CEP>
              <Cidade>sample string 6</Cidade>
              <Complemento>sample string 4</Complemento>
              <Endereco>sample string 2</Endereco>
              <Estado>sample string 7</Estado>
              <NumeroDoEndereco>sample string 3</NumeroDoEndereco>
              <Ordem>8</Ordem>
            </Endereco>
            <Nome>sample string 1</Nome>
            <NumeroDoDocumento>3</NumeroDoDocumento>
            <Qualificacao>sample string 5</Qualificacao>
            <TipoDeDocumento>sample string 2</TipoDeDocumento>
          </CartaApiDadosDoApresentante>
        </DadosDosApresentantes>
        <DataDaEmissao>2025-12-06T00:44:51.9994324-03:00</DataDaEmissao>
        <DataDoProtocolo>2025-12-06T00:44:51.9994324-03:00</DataDoProtocolo>
        <DataDoVencimento>2025-12-06T00:44:51.9994324-03:00</DataDoVencimento>
        <DescricaoDaEspecie>sample string 7</DescricaoDaEspecie>
        <DescricaoDoVencimento>sample string 10</DescricaoDoVencimento>
        <Endosso>sample string 11</Endosso>
        <IdentificacaoDaDivida>sample string 17</IdentificacaoDaDivida>
        <NumeroDoProtocolo>1</NumeroDoProtocolo>
        <NumeroDoTitulo>sample string 8</NumeroDoTitulo>
        <Origem>sample string 18</Origem>
        <PrazoLimite>2025-12-06T00:44:51.9994324-03:00</PrazoLimite>
        <ProtestoComDireitoDeRegresso>true</ProtestoComDireitoDeRegresso>
        <Sacador>
          <Endereco>
            <Bairro>sample string 5</Bairro>
            <CEP>1</CEP>
            <Cidade>sample string 6</Cidade>
            <Complemento>sample string 4</Complemento>
            <Endereco>sample string 2</Endereco>
            <Estado>sample string 7</Estado>
            <NumeroDoEndereco>sample string 3</NumeroDoEndereco>
            <Ordem>8</Ordem>
          </Endereco>
          <Nome>sample string 1</Nome>
          <NumeroDoDocumento>3</NumeroDoDocumento>
          <Qualificacao>sample string 4</Qualificacao>
          <TipoDeDocumento>sample string 2</TipoDeDocumento>
        </Sacador>
        <SiglaDaEspecie>sample string 6</SiglaDaEspecie>
        <TipoDaDivida>sample string 16</TipoDaDivida>
        <TipoDoProtesto>sample string 4</TipoDoProtesto>
        <ValorAProtestar>13</ValorAProtestar>
        <ValorOriginal>12</ValorOriginal>
        <ValorParaCancelamento>19</ValorParaCancelamento>
        <VencimentoID>5b27c424-c052-48bd-ab6c-e11183557961</VencimentoID>
      </CartaApiDadosDoTitulo>
    </DadosDoTitulo>
    <DataParaDistribuicao>2025-12-06T00:44:51.9994324-03:00</DataParaDistribuicao>
  </InformacoesCartaParaCancelamento>
  <PedidoID>4dd33657-8f41-466b-bd14-f51290f59ab8</PedidoID>
</CartaParaCancelamentoRequestApi>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.