Criar Cobranca com Vencimento
Através desse endpoint será possível criar as cobranças com vencimento por Pix.
PUT https://sandbox-api.openbank.stone.com.br/api/v1/cobv/{txid}
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
txid* string
Validação: “^[a-zA-Z0-9]{26,35}$”
BODY PARAMS
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:
{
"calendario": {
"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"loc": {
"id": 789
},
"devedor": {
"logradouro": "Alameda Souza, Numero 80, Bairro Braz",
"cidade": "Recife",
"uf": "PE",
"cep": "70011750",
"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"valor": {
"original": "123.45",
"multa": {
"modalidade": "2",
"valorPerc": "15.00"
},
"juros": {
"modalidade": "2",
"valorPerc": "2.00"
},
"desconto": {
"modalidade": "1",
"descontoDataFixa": [
{
"data": "2020-11-30",
"valorPerc": "30.00"
}
]
}
},
"chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
"solicitacaoPagador": "Cobrança dos serviços prestados."
}
Response
201 OK
{
"calendario": {
"criacao": "2020-09-09T20:15:00.358Z",
"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"revisao": 0,
"loc": {
"id": 789,
"location": "pix.example.com/qr/c2/cobv/9d36b84fc70b478fb95c12729b90ca25",
"tipoCob": "cobv"
},
"status": "ATIVA",
"devedor": {
"logradouro": "Alameda Souza, Numero 80, Bairro Braz",
"cidade": "Recife",
"uf": "PE",
"cep": "70011750",
"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"recebedor": {
"logradouro": "Rua 15 Numero 1200, Bairro São Luiz",
"cidade": "São Paulo",
"uf": "SP",
"cep": "70800100",
"cnpj": "56989000019533",
"nome": "Empresa de Logística SA"
},
"valor": {
"original": "123.45"
},
"chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
"solicitacaoPagador": "Cobrança dos serviços prestados."
}
400 Bad Request
{
"type": "https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida",
"title": "Cobrança inválida.",
"status": 400,
"detail": "A requisição que busca alterar ou criar uma cobrança com vencimento não respeita o schema ou está semanticamente errada.",
"violacoes": {
"propriedade": "original",
"razao": "tem seu formato inválido",
"valor": "@@@"
}
}
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."
}