55 - Update Bill

Scopes:

api.ext api.boleto.alterar

Altera os dados de um boleto bancário.

cURL

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/Boleto/Alterar \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "codigoRegistroBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "codigoBarras": "<string>",
  "dadosBoleto": {
    "dtVencimento": "2023-11-07T05:31:56Z",
    "dtLimPgto": "2023-11-07T05:31:56Z",
    "numDocTit": "<string>",
    "vlrAbatimento": 123,
    "vlrTit": 123,
    "numeroDocumento": "<string>"
  },
  "pagador": {
    "tipoPessoa": 1,
    "documentoFederal": "<string>",
    "nomeRazao": "<string>",
    "nomeFantasia": "<string>",
    "logradouro": "<string>",
    "cidade": "<string>",
    "uf": "<string>",
    "cep": "<string>",
    "bairro": "<string>",
    "numero": "<string>",
    "complemento": "<string>",
    "email": "<string>",
    "telefone": "<string>"
  },
  "sacadorAvalista": {
    "tipo": 0,
    "identificador": "<string>",
    "nomeSacadorAvalista": "<string>"
  },
  "juros": {
    "data": "2023-11-07T05:31:56Z",
    "codigo": "<string>",
    "vlr": 123
  },
  "multa": {
    "data": "2023-11-07T05:31:56Z",
    "codigo": "<string>",
    "vlr": 123
  },
  "desconto": {
    "data": "2023-11-07T05:31:56Z",
    "codigo": "<string>",
    "vlr": 123
  },
  "descontos": [
    {
      "data": "2023-11-07T05:31:56Z",
      "codigo": "<string>",
      "vlr": 123
    }
  ],
  "identificadorCliente": "<string>",
  "instrucoesBeneficiario": [
    "<string>"
  ]
}
'

200

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoAlteracaoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "situacaoBoleto": 1
}

Through this endpoint, the partner can allow the operator to make updates to a given bill as long as it is within the due date and has not been paid.

Authorizations

Authorization · string · header · required

Copie 'Bearer ' + token

Headers

IdempotencyKey · string · required

IgnoraHandshake · boolean · default: true · required

(somente em homologação)

Body

codigoRegistroBoleto · string<uuid> | null

codigoBarras · string | null

dadosBoleto · object

Show child attributes

dadosBoleto. dtVencimento · string<date-time> | null

Data do vencimento do boleto.

dadosBoleto. dtLimPgto · string<date-time> | null

Data limite do pagamento do boleto.

dadosBoleto. numDocTit · string | null

Número do documento do título.

dadosBoleto. vlrAbatimento · number<double>

Valor do abatimento.

dadosBoleto. vlrTit · number<double> | null

Valor do título.

dadosBoleto. numeroDocumento · string | null

Número do documento.

pagador · object

Show child attributes

pagador. tipoPessoa · enum<integer>

Available options: 1, 2

pagador. documentoFederal · string | null

pagador. nomeRazao · string | null

pagador. nomeFantasia · string | null

pagador. logradouro · string | null

pagador. cidade · string | null

pagador. uf · string | null

pagador. cep · string | null

pagador. bairro · string | null

pagador. numero · string | null

pagador. complemento · string | null

pagador. email · string | null

pagador. telefone · string | null

sacadorAvalista · object

Show child attributes

sacadorAvalista. tipo · enum<integer>

Tipo de sacador avalista.

Valores: 0 - Isento 1 - CPF 2 - CNPJ 3 - PIS/PASEP 9 - Outros

Available options: 0, 1, 2, 3, 9

sacadorAvalista. identificador · string | null

Identificador do sacador avalista.

sacadorAvalista. nomeSacadorAvalista · string | null

Nome do sacador avalista.

juros · object

Show child attributes

juros. data · string<date-time> | null

Data associada ao item calculável.

juros. codigo · string | null

Código do item calculável.

juros. vlr · number<double>

Valor do item calculável.

multa · object

Show child attributes

multa. data · string<date-time> | null

Data associada ao item calculável.

multa. codigo · string | null

Código do item calculável.

multa. vlr · number<double>

Valor do item calculável.

desconto · object

Show child attributes

desconto. data · string<date-time> | null

Data associada ao item calculável.

desconto. codigo · string | null

Código do item calculável.

desconto. vlr · number<double>

Valor do item calculável.

descontos · object[] | null

Show child attributes

descontos. data · string<date-time> | null

Data associada ao item calculável.

descontos. codigo · string | null

Código do item calculável.

descontos. vlr · number<double>

Valor do item calculável.

identificadorCliente · string | null

instrucoesBeneficiario · string[] | null

Response

200

application/json

Success

sucesso · boolean

mensagem · string | null

codigoAlteracaoBoleto · string<uuid>

situacaoBoleto · enum<integer>

Available options: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10