26 - Cancel Future Entries

Cancela um agendamento de lançamento futuro.

curl --request DELETE \
  --url https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento}"

headers = {"Authorization": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
    }
  ]
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

Cancela um agendamento de lançamento futuro.

curl --request DELETE \
  --url https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento}"

headers = {"Authorization": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ext.dbs.moneyp.dev.br/api/LancamentosFuturos/{codigoAgendamento}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
    }
  ]
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

Through this endpoint, the partner can cancel a future launch using a pre-scheduling code.

Authorizations

Authorization

string

header

required

Copie 'Bearer ' + token

Path Parameters

codigoAgendamento

string<uuid>

required

Código UUID identificador do agendamento prévio.

Response

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>

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,

1014,

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<double>

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>

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.

Show child attributes

Initial Guide

Developer's Guide

API References

26 - Cancel Future Entries

Authorizations

Path Parameters

Response