InformaçãoPOST /v2/cob
Requer autorização para o escopo:
cob.writeRequisição
- Exemplo 1 (CPF)
- Exemplo 2 (CNPJ)
- Exemplo 3 (loc)
{
"calendario": {
"expiracao": 3600
},
"devedor": {
"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"valor": {
"original": "123.45"
},
"chave": "71cdf9ba-c695-4e3c-b010-abb521a3f1be",
"solicitacaoPagador": "Cobrança dos serviços prestados."
}
{
"calendario": {
"expiracao": 3600
},
"devedor": {
"cnpj": "12345678000195",
"nome": "Empresa de Serviços SA"
},
"valor": {
"original": "37.00"
},
"chave": "ac107ed7-97cd-4fe7-8df5-a5f5659bf2f3",
"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"
}
]
}
{
"calendario": {
"expiracao": 3600
},
"devedor": {
"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"valor": {
"original": "123.45"
},
"loc": {
"id": 1
},
"chave": "71cdf9ba-c695-4e3c-b010-abb521a3f1be",
"solicitacaoPagador": "Cobrança dos serviços prestados."
}
Respostas
As respostas abaixo representam Sucesso(201) e Falhas/erros do consumo.
- 🟢 201
- 🔴 400
- 🔴 409
- 🔴 429
- 🔴 500
{
"calendario": {
"criacao": "2020-09-09T20:15:00.358Z",
"expiracao": 3600
},
"txid": "7978c0c97ea847e78e8849634473c1f1",
"revisao": 0,
"loc": {
"id": 789,
"location": "pix.example.com/qr/v2/9d36b84fc70b478fb95c12729b90ca25",
"tipoCob": "cob"
},
"location": "pix.example.com/qr/v2/9d36b84fc70b478fb95c12729b90ca25",
"status": "ATIVA",
"devedor": {
"cnpj": "12345678000195",
"nome": "Empresa de Serviços SA"
},
"valor": {
"original": "567.89"
},
"chave": "a1f4102e-a446-4a57-bcce-6fa48899c1d1",
"solicitacaoPagador": "Informar cartão fidelidade",
"pixCopiaECola": "00020101021226830014BR.GOV.BCB.PIX2561qrcodespix.sejaefi.com.br/v2/41e0badf811a4ce6ad8a80b306821fce5204000053000065802BR5905EFISA6008SAOPAULO60070503***61040000"
}
InvalidOperationError
{
"nome": "documento_bloqueado",
"mensagem": "O documento desta conta tem bloqueios que impedem a emissão"
}
Ou
{
"nome": "chave_invalida",
"mensagem": "A chave informada não faz referência à conta Efí autenticada"
}
InvalidValueError
{
"nome": "valor_invalido",
"mensagem": "Campo valor.original deve ser maior que zero"
}
Ou
{
"nome": "valor_invalido",
"mensagem": "Campo calendario.expiracao deve ser maior que zero"
}
Ou
{
"nome": "valor_invalido",
"mensagem": "Documento CPF em devedor.cpf é inválido"
}
Ou
{
"nome": "valor_invalido",
"mensagem": "Documento CNPJ em devedor.cnpj é inválido"
}
DuplicatedRegisterError
{
"nome": "txid_duplicado",
"mensagem": "Campo txid informado já foi utilizado em outra cobrança"
}
{
"nome": "Limite de Requisições Excedido",
"mensagem": "As requisições estão temporariamente limitadas. Aguarde um momento e tente novamente"
}
ApplicationError
{
"nome": "erro_aplicacao",
"mensagem": "Ocorreu um erro ao validar a chave"
}