{
  "codigoConta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "codigoTicket": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parceiro": "<string>",
  "contaPgto": "<string>",
  "descricao": "<string>",
  "dtInclusao": "2023-11-07T05:31:56Z",
  "origemTransacao": 0,
  "dtAgendamento": "2023-11-07T05:31:56Z",
  "valor": 123,
  "nome": "<string>",
  "documentoFederal": "<string>",
  "numeroBanco": "<string>",
  "descricaoBanco": "<string>",
  "agencia": "<string>",
  "agenciaDigito": "<string>",
  "contaDestino": "<string>",
  "contaDigitoDestino": "<string>",
  "contaPgtoDestino": "<string>",
  "chavePix": "<string>",
  "codigoBarras": "<string>",
  "linhaDigitavel": "<string>",
  "situacao": 10,
  "autorizacoes": [
    {
      "nomeAutorizador": "<string>",
      "situacaoAprovacao": 0,
      "dtAprovacao": "2023-11-07T05:31:56Z"
    }
  ]
}
Por meio deste endpoint, o parceiro pode realizar o cancelamento de um lançamento futuro através de um código de agendamento prévio.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Path Parameters

​
codigoAgendamento
string<uuid>
required

Código UUID identificador do agendamento prévio.

Response

200 - application/json

Success

​
codigoConta
string<uuid>

Código UUID identificador da Conta Bancária de destino.

​
codigoTicket
string<uuid>
​
codigo
string<uuid>

Código UUID identificador do registro de Agendamento.

​
parceiro
string | null

Nome do Parceiro.

​
contaPgto
string | null

Combinação de número da Conta Bancária de Origem + Número da Agência de Origem. Sem espaços ou caracteres especiais.

​
descricao
string | null

Descrição/Nome da Conta Bancária de Origem.

​
dtInclusao
string<date-time>

Data de inclusão do registro.

​
origemTransacao
enum<integer>

0 = MovimentoManual; 1 = Transferência Interna; 2 = Envio TED; 3 = Pagamento de Boleto; 4 = EnvioTransfCR; 5 = Pix; 6 = PagamentoTituloConcessionaria; 7 = CompraCartao; 8 = SaqueCartao; 9 = SolicitacaoCartao; 10 = Cobrança Recorrente; 501 = Recebimento de Transfêrencia; 502 = Recebimento de TED; 503 = Recebimento de Boleto; 504 = RecebTransfCR; 505 = Recebimento de PIX; 506 = Recebimento de Crédito Operacional; 507 = Recebimento de Boleto Unificado; 1001 = DevolucaoTransf; 1002 = Devolução TED; 1003 = DevolucaoTitulo; 1004 = DevolucaoTransfCR; 1005 = EstornoPix; 1006 = Devolução Pix; 1007 = DevolucaoPagamentoTituloConcessionaria; 1008 = DevolucaoCompraCartao; 1009 = DevolucaoSaqueCartao; 1010 = DevolucaoLDL; 1011 = EstornoDevolucaoLDL; 1012 = DevolucaoLTR; 1013 = EstornoDevolucaoLTR; 1200 = BoletoComunicacao; 1501 = RegistroBoleto; 1502 = AlteracaoBoleto; 1503 = CancelamentoBoleto; 1601 = ProtestoBoleto; 1701 = CessaoBoleto; 2001 = CNAB_REG; 2002 = CNAB_PGT; 2003 = CNAB_ALT; 2004 = CNAB_CAN; 2010 = CNABRemessa; 2012 = CNABRetorno; 2501 = Split; 3001 = Servico; 3002 = BloqueioServico; 4001 = Safe; 4501 = PreviaBoletoCredito; 5001 = RejeicaoEnvioPix; 5002 = RejeicaoRecebePix; 5003 = RejeicaoEstornoPix; 5004 = RejeicaoDevolucaoPix

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
501,
502,
503,
504,
505,
506,
507,
1001,
1002,
1003,
1004,
1005,
1006,
1007,
1008,
1009,
1010,
1011,
1012,
1013,
1200,
1501,
1502,
1503,
1601,
1701,
2001,
2002,
2003,
2004,
2010,
2012,
2501,
3001,
3002,
4001,
4501,
5001,
5002,
5003,
5004
​
dtAgendamento
string<date-time>

Data e hora da efetivação do Agendamento da Transação Financeira.

​
valor
number

Valor total da Transação agendada.

​
nome
string | null

Nome completo do Agendador.

​
documentoFederal
string | null

CPF ou CNPJ do Agendador, à depender da natureza do mesmo.

​
numeroBanco
string | null

Código da Instituição Financeira de destino.

​
descricaoBanco
string | null

Nome da Instituição Financeira de destino.

​
agencia
string | null

Número da Agência de destino.

​
agenciaDigito
string | null

Dígito verificador da Agência de destino.

​
contaDestino
string | null

Númmero da Conta Bancária de destino.

​
contaDigitoDestino
string | null

Dígito verificador da Conta Bancária de destino.

​
contaPgtoDestino
string | null

Combinação de número da Conta Bancária de destino + Número da Agência de destino. Sem espaços ou caracteres especiais.

​
chavePix
string | null

Chave PIX da transferência. Presente somente em registros cujo a Origem da Transação seja Envio de Pix.

​
codigoBarras
string | null

Código de Barras do Boleto. Presente somente em registros cujo a Origem da Transação seja Pagamento de Boleto.

​
linhaDigitavel
string | null

Linha Digitável do Boleto. Presente somente em registros cujo a Origem da Transação seja Pagamento de Boleto.

​
situacao
enum<integer>

10 = Validar; 11 = Validando; 12 = Validado; 21 = VerificandoAprovacao; 22 = EmAprovacao; 23 = Aprovado; 24 = Reprovado; 31 = VerificandoAgendamento; 32 = Agendado; 33 = Executar; 34 = Cancelado; 35 = Registrado em Agendamento Recorrente Pix; 41 = Executando; 42 = Executado; 50 = Reprocessar; 51 = Reprocessar Validação

Available options:
10,
11,
12,
21,
22,
23,
24,
31,
32,
33,
34,
35,
41,
42,
50,
51
​
autorizacoes
object[] | null

Lista de Autorizações da Transação associadas ao Agendamento.