Criar Lote Cobranças Vencimento
Através desse endpoint será possível criar lote de cobranças com vencimento por Pix.
PUT 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:
{
"descricao": "Cobranças dos alunos do turno vespertino",
"cobsv": [
{
"calendario": {
"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"txid": "fb2761260e554ad593c7226beb5cb650",
"loc": {
"id": 789
},
"devedor": {
"logradouro": "Alameda Souza, Numero 80, Bairro Braz",
"cidade": "Recife",
"uf": "PE",
"cep": "70011750",
"cpf": "08577095428",
"nome": "João Souza"
},
"valor": {
"original": "100.00"
},
"chave": "7c084cd4-54af-4172-a516-a7d1a12b75cc",
"solicitacaoPagador": "Informar matrícula"
},
{
"calendario": {
"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"loc": {
"id": 57221
},
"devedor": {
"logradouro": "Rua 15, Numero 1, Bairro Campo Grande",
"cidade": "Recife",
"uf": "PE",
"cep": "70055751",
"cpf": "15311295449",
"nome": "Manoel Silva"
},
"valor": {
"original": "100.00"
},
"chave": "7c084cd4-54af-4172-a516-a7d1a12b75cc",
"solicitacaoPagador": "Informar matrícula"
}
]
}
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/LoteCobVOperacaoInvalida",
"title": "Cobrança inválida.",
"status": 400,
"detail": "A requisição que busca alterar ou criar um lote de cobranças com vencimento não respeita o schema ou está semanticamente errada.",
"violacoes": {
"propriedade": "id",
"razao": "Não respeita o schema"
}
}
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."
}