Revisar Lote Cobranças Vencimento
Através desse endpoint será possível atualizar lote de cobranças com vencimento por Pix.
PATCH https://sandbox-api.openbank.stone.com.br/api/v1/lotecobv/{id}
HEADERS
authorization* string
Bearer token de autenticação.
x-stone-account-id* string
Necessário para permissionamento.
x-stone-idempotency-id* string
Para garantir idempotência das operações.
PATH PARAMS
id* string
BODY PARAMS
descricao string
cobsv object
txid* string
Format: “^[a-zA-Z0-9]{26,35}$”
calendario object
dataDeVencimento* date
**validadeAposVencimento** integer
Quantidade de dias corridos após calendario.dataDeVencimento em que a cobrança poderá ser paga
loc object
id integer
devedor object
logradouro string
cidade string
uf string
cep string
cpf string
nome string
valor object
original* string
Format: \d{1,10}.\d{2}
Valor original da cobrança. Ex: 123,34
**abatimento** object
**modalidade** string
Valores permitidos:
Fixo: 1
Percentual: 2
**valorPerc** string
Format: \d{1,10}.\d{2}
**multa** object
**modalidade** string
Valores permitidos:
Fixo: 1
Percentual: 2
**valorPerc** string
Format: \d{1,10}.\d{2}
**juros** object
**modalidade** string
Valores permitidos:
Valor (dias corridos): 1
Percentual ao dia (dias corridos): 2
Percentual ao mês (dias corridos): 3
Percentual ao ano (dias corridos): 4
Valor (dias úteis): 5
Percentual ao dia (dias úteis): 6
Percentual ao mês (dias úteis): 7
Percentual ao ano (dias úteis): 8
**valorPerc** string
Format: \d{1,10}.\d{2}
**desconto** object
**modalidade** string
Valores permitidos:
Valor Fixo até a[s] data[s] informada[s]: 1
Percentual até a data informada: 2
Valor por antecipação dia corrido: 3
Valor por antecipação dia útil: 4
Percentual por antecipação dia corrido: 5
Percentual por antecipação dia útil: 6
**valorPerc** string
Obrigatório para modalidades 3 a 6
Format: \d{1,10}.\d{2}
**descontoDataFixa** object
Obrigatório para modalidades 1 a 2
**data** date
**valorPerc** string
Format: \d{1,10}.\d{2}
chave string
Chave Pix do dono da conta
solicitacaoPagador string
Solicitação ao pagador - campo de texto livre
infoAdicionais list of object
nome string
valor string
Exemplo:
{
"cobsv": [
{
"calendario": {
"dataDeVencimento": "2020-01-10"
},
"txid": "fb2761260e554ad593c7226beb5cb650",
"valor": {
"original": "110.00"
}
},
{
"calendario": {
"dataDeVencimento": "2020-01-10"
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"valor": {
"original": "110.00"
}
}
]
}
Response
202 OK
{
"message": "Solicitação de revisão do Lote de cobranças encaminhada para processamento."
}
400 Bad Request
{
"type": "https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida",
"title": "Operação inválida.",
"status": 400,
"detail": "Cobrança não encontra-se mais com o status ATIVA, somente cobranças ativas podem ser revisadas."
}
403 Forbidden
{
"type": "https://pix.bcb.gov.br/api/v2/error/AcessoNegado",
"title": "Acesso Negado",
"status": 403,
"detail": "Requisição de participante autenticado que viola alguma regra de autorização."
}