Criar Cobrança imediata
Através desse endpoint será possível criar as cobranças imediatas por Pix.
PUT https://sandbox-api.openbank.stone.com.br/api/v1/cob/{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
**expiracao*** date
Tempo de vida da cobrança em segundos. O padrão é 86400
loc object
id integer
devedor object
cpf ou cnpj string
nome string
valor* object
**original*** string
Format: \d{1,10}.\d{2}
Valor original da cobrança. Ex: 123,34
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": {
"expiracao": 3600
},
"devedor": {
"cnpj": "12345678000195",
"nome": "Empresa de Serviços SA"
},
"valor": {
"original": "37.00",
"modalidadeAlteracao": 1
},
"chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
"solicitacaoPagador": "Serviço realizado.",
"infoAdicionais": [
{
"nome": "Campo 1",
"valor": "Informação Adicional1 do PSP-Recebedor"
},
{
"nome": "Campo 2",
"valor": "Informação Adicional2 do PSP-Recebedor"
}
]
}
Response
201 OK
{
"calendario": {
"criacao": "2020-09-09T20:15:00.358Z",
"expiracao": 3600
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"revisao": 0,
"loc": {
"id": 789,
"location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
"tipoCob": "cob"
},
"location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
"status": "ATIVA",
"devedor": {
"cnpj": "12345678000195",
"nome": "Empresa de Serviços SA"
},
"valor": {
"original": "37.00",
"modalidadeAlteracao": 1
},
"chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
"solicitacaoPagador": "Serviço realizado.",
"infoAdicionais": [
{
"nome": "Campo 1",
"valor": "Informação Adicional1 do PSP-Recebedor"
},
{
"nome": "Campo 2",
"valor": "Informação Adicional2 do PSP-Recebedor"
}
]
}
400 Bad Request
{
"type": "https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida",
"title": "Cobrança inválida.",
"status": 400,
"detail": "A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o schema ou está semanticamente errada.",
"violacoes": {
"propriedade": "devedor.cpf ou devedor.cnpj",
"razao": "deve ser preenchido"
}
}
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."
}
404 Not Found
{
"type": "https://pix.bcb.gov.br/api/v2/error/NaoEncontrado",
"title": "Não Encontrado",
"status": 404,
"detail": "Entidade não encontrada."
}