Revisar cobrança com vencimento

patch https://api.pix.voluti.com.br/cobv/{txid}

Use este endpoint para revisar uma cobrança com vencimento.

Path Params

txid

string

required

Identificador da transação (txid):

O campo txid determina o identificador da transação, sendo crucial para o processo de conciliação de pagamentos, pois determina a transação de forma única. Na pacs.008, é mencionado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Funcionalidade:

O txid é gerado pelo usuário recebedor e enviado ao PSP do pagador.
Após a confirmação do pagamento, é transmitido para o SPI via pacs.008 e também para o PSP do recebedor.
Ao detectar um pagamento com txid, o PSP do recebedor pode informar ao usuário recebedor sobre a liquidação específica desse pagamento.

Responsabilidades:

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade.
Cada txid é único por CPF/CNPJ do usuário recebedor, com a validação dessa regra realizada pelo PSP recebedor na API Pix.

Body Params

Dados para geração da cobrança.

calendario

object

Os campos contidos sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

devedor

object

O objeto devedor organiza as informações sobre o devedor da cobrança.

status

string

Defaults to REMOVIDA_PELO_USUARIO_RECEBEDOR

Estado do registro da cobrança com status unico.

REMOVIDO_PELO_USUARIO_RECEBEDOR: Indica que o usuário recebedor solicitou a remoção do registro da cobrança.

valor

object

Valores monetários.

chave

string

length ≤ 77

Formato da Chave Pix na qual a conta receberá o valor.

Conforme especificado na PACS.008. Os tipos de chave permitidos são:

Telefone
E-mail
CPF/CNPJ
O Endereço Virtual de Pagamento (EVP)

O formato detalhado das chaves está na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para Iniciação do Pix.
.

solicitacaoPagador

string

length ≤ 140

Permite que o pagador inclua um texto livre relacionado ao recebedor.

Preenchimento: O PSP do pagador insere esse texto no campo RemittanceInformation da pacs.008.

Limite de caracteres: Restrito a 140 caracteres.

infoAdicionais

array of objects

Apresentação das informações adicionais ao pagador:

Cada informação adicional contida nos campos nome e valor deve ser exibida ao pagador.

Informações adicionais

Responses

Response body

object

calendario

object

required

Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

criacao

date-time

required

Timestamp que indica o momento em que foi criada a cobrança. Respeita o formato definido na RFC 3339.

dataDeVencimento

date

required

Trata-se de uma data, no formato YYYY-MM-DD, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia.

validadeAposVencimento

int32

Defaults to 30

Trata-se da quantidade de dias corridos após calendario.dataDeVencimento,
em que a cobrança poderá ser paga.

Sempre que a data de vencimento cair em um fim de semana ou em um feriado para o usuário pagador,
ela deve ser automaticamente prorrogada para o primeiro dia útil subsequente. Todos os campos
que façam referência a esta data (validadeAposVencimento; desconto; juros e multa) devem assumir
essa prorrogação, quando for o caso.

Para ilustrar o funcionamento, seguem alguns exemplos, onde:

(#) representa a data de vencimento;
(*) representa a data ajustada em função de dias não úteis;
os (<número>) correspondem aos dias adicionais de validade para o pagamento.

Exemplo A:

dataDeVencimento: 2020-10-20, terça-feira.
validadeAposVencimento: 4

Tenta-se pagar no dia 2020-10-20, terça: aceito. (#)(*)
Tenta-se pagar no dia 2020-10-21, quarta: aceito. (1)
Tenta-se pagar no dia 2020-10-22, quinta: aceito. (2)
Tenta-se pagar no dia 2020-10-23, sexta: aceito. (3)
Tenta-se pagar no dia 2020-10-24, sábado: aceito. 
Tenta-se pagar no dia 2020-10-25, domingo: aceito. (Feriado)
Tenta-se pagar no dia 2020-10-26, segunda: aceito. (4)
Tenta-se pagar no dia 2020-10-27, terça: negado.

Exemplo B:

dataDeVencimento: 2020-12-25, sexta-feira, feriado.
validadeAposVencimento: 0

Tenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado)
Tenta-se pagar no dia 2020-12-26, sábado: aceito.
Tenta-se pagar no dia 2020-12-27, domingo: aceito.
Tenta-se pagar no dia 2020-12-28, segunda: aceito. (*)
Tenta-se pagar no dia 2020-12-29, terça: negado.

Exemplo C:

dataDeVencimento: 2020-12-25, sexta-feira, feriado.
validadeAposVencimento: 1

Tenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado)
Tenta-se pagar no dia 2020-12-26, sábado: aceito.
Tenta-se pagar no dia 2020-12-27, domingo: aceito.
Tenta-se pagar no dia 2020-12-28, segunda: aceito. (*)
Tenta-se pagar no dia 2020-12-29, terça: aceito. (1)
Tenta-se pagar no dia 2020-12-30, quarta: negado.

Exemplo D:

dataDeVencimento: 2020-12-25, sexta-feira, feriado.
validadeAposVencimento: 3

Tenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado)
Tenta-se pagar no dia 2020-12-26, sábado: aceito.
Tenta-se pagar no dia 2020-12-27, domingo: aceito.
Tenta-se pagar no dia 2020-12-28, segunda: aceito. (*)
Tenta-se pagar no dia 2020-12-29, terça: aceito. (1)
Tenta-se pagar no dia 2020-12-30, quarta: aceito. (2)
Tenta-se pagar no dia 2020-12-31, quinta: aceito. (3)
Tenta-se pagar no dia 2021-01-01, sexta: negado.

Exemplo E:

dataDeVencimento: 2020-12-25, sexta-feira, feriado.
validadeAposVencimento: 4

Tenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado)
Tenta-se pagar no dia 2020-12-26, sábado: aceito.
Tenta-se pagar no dia 2020-12-27, domingo: aceito.
Tenta-se pagar no dia 2020-12-28, segunda: aceito. (*)
Tenta-se pagar no dia 2020-12-29, terça: aceito. (1)
Tenta-se pagar no dia 2020-12-30, quarta: aceito. (2)
Tenta-se pagar no dia 2020-12-31, quinta: aceito. (3)
Tenta-se pagar no dia 2021-01-01, sexta: aceito. (Feriado)
Tenta-se pagar no dia 2021-01-02, sábado: aceito.
Tenta-se pagar no dia 2021-01-03, domingo: aceito.
Tenta-se pagar no dia 2021-01-04, segunda: aceito. (4)
Tenta-se pagar no dia 2021-01-05, terça: negado.

Exemplo F:

dataDeVencimento: 2021-08-27, sexta-feira.
validadeAposVencimento: 5

Tenta-se pagar no dia 2021-08-27, sexta: aceito. (#)(*)
Tenta-se pagar no dia 2021-08-28, sábado: aceito. (1)
Tenta-se pagar no dia 2021-08-29, domingo: aceito. (2)
Tenta-se pagar no dia 2021-08-30, segunda: aceito. (3)
Tenta-se pagar no dia 2021-08-31, terça: aceito. (4)
Tenta-se pagar no dia 2021-09-01, quarta: aceito. (5)
Tenta-se pagar no dia 2021-09-02, quinta: negado.

Exemplo G:

dataDeVencimento: 2021-08-28, sábado.
validadeAposVencimento: 5

Tenta-se pagar no dia 2021-08-28, sábado: aceito. (#)
Tenta-se pagar no dia 2021-08-29, domingo: aceito. 
Tenta-se pagar no dia 2021-08-30, segunda: aceito. (*)
Tenta-se pagar no dia 2021-08-31, terça: aceito. (1)
Tenta-se pagar no dia 2021-09-01, quarta: aceito. (2)
Tenta-se pagar no dia 2021-09-02, quinta: aceito. (3)
Tenta-se pagar no dia 2021-09-03, sexta: aceito. (4)
Tenta-se pagar no dia 2021-09-04, sabado: aceito. 
Tenta-se pagar no dia 2021-09-05, domingo: aceito. 
Tenta-se pagar no dia 2021-09-06, segunda: aceito. (5)

txid

string

required

Identificador da transação (txid):

Funcionalidade:

O txid é gerado pelo usuário recebedor e enviado ao PSP do pagador.
Após a confirmação do pagamento, é transmitido para o SPI via pacs.008 e também para o PSP do recebedor.
Ao detectar um pagamento com txid, o PSP do recebedor pode informar ao usuário recebedor sobre a liquidação específica desse pagamento.

Responsabilidades:

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade.
Cada txid é único por CPF/CNPJ do usuário recebedor, com a validação dessa regra realizada pelo PSP recebedor na API Pix.

revisao

int32

required

Indica a revisão da cobrança, começando sempre em zero e aumentando em incrementos de 1.

Incremento: A revisão é incrementada sempre que um objeto da cobrança é alterado, exceto pelo campo loc.
Exceção: Se a única alteração em uma cobrança for no campo loc, a revisão não é incrementada, pois o loc não altera a cobrança em si.
Armazenamento: Não é necessário manter histórico das alterações do campo loc, mas é necessário para outros campos da cobrança.

devedor

object

O objeto devedor organiza as informações sobre o devedor da cobrança.

recebedor

object

O objeto recebedor organiza as informações sobre o credor da cobrança.

loc

object

Identificador da localização do payload.

int64

required

Identificador da localização a ser informada na criação da cobrança.

location

uri

required

length ≤ 77

Localização do payload a ser informada na criação da cobrança.

tipoCob

string

required

Tipo de cobrança.

cob cobv

criacao

date-time

required

Data e hora em que a localização foi criada. Respeita RFC 3339.

status

string

required

Estado do registro da cobrança.

Os status:

ATIVA: Indica que o registro se refere a uma cobrança que foi gerada mas ainda não foi paga nem removida;
CONCLUIDA: Indica que o registro se refere a uma cobrança que já foi paga e, por conseguinte, não pode acolher outro pagamento;
REMOVIDO_PELO_USUARIO_RECEBEDOR: Indica que o usuário recebedor solicitou a remoção do registro da cobrança;
REMOVIDO_PELO_PSP: Indica que o PSP recebedor solicitou a remoção do registro da cobrança.

ATIVA CONCLUIDA REMOVIDA_PELO_USUARIO_RECEBEDOR REMOVIDA_PELO_PSP

valor

object

required

Valores monetários.

original

string

Valor original da cobrança.

multa

object

Multa aplicada à cobrança

juros

object

Juro aplicado à cobrança

abatimento

object

Abatimento aplicado à cobrança

desconto

object

Descontos aplicados à cobrança

pixCopiaECola

string

length ≤ 512

Este campo retorna o valor do Pix Copia e Cola correspondente à cobrança. Trata-se da sequência de caracteres que representa o BR Code.

chave

string

length ≤ 77

Formato da Chave Pix na qual a conta receberá o valor.

Conforme especificado na PACS.008. Os tipos de chave permitidos são:

Telefone
E-mail
CPF/CNPJ
O Endereço Virtual de Pagamento (EVP)

O formato detalhado das chaves está na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para Iniciação do Pix.
.

solicitacaoPagador

string

length ≤ 140

Permite que o pagador inclua um texto livre relacionado ao recebedor.

Preenchimento: O PSP do pagador insere esse texto no campo RemittanceInformation da pacs.008.

Limite de caracteres: Restrito a 140 caracteres.

infoAdicionais

array of objects

Apresentação das informações adicionais ao pagador:

Cada informação adicional contida nos campos nome e valor deve ser exibida ao pagador.

Informações adicionais

object

nome

string

required

length ≤ 50

Nome do pagador.

valor

string

required

length ≤ 200

Valor de cobrança.

Language

Credentials

OAuth2


xxxxxxxxxx
12
1
curl --request PATCH \
2
     --url https://api.pix.voluti.com.br/cobv/txid \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "calendario": {
8
    "validadeAposVencimento": 30
9
  },
10
  "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR"
11
}
12
'


xxxxxxxxxx
36
}
1
{
2
  "calendario": {
3
    "criacao": "2020-09-09T20:15:00.358Z",
4
    "dataDeVencimento": "2020-12-31",
5
    "validadeAposVencimento": 30
6
  },
7
  "txid": "7978c0c97ea847e78e8849634473c1f1",
8
  "revisao": 0,
9
  "loc": {
10
    "id": 789,
11
    "location": "pix.example.com/qr/c2/cobv/9d36b84fc70b478fb95c12729b90ca25",
12
    "tipoCob": "cobv"
13
  },
14
  "status": "ATIVA",
15
  "devedor": {
16
    "logradouro": "Alameda Souza, Numero 80, Bairro Braz",
17
    "cidade": "Recife",
18
    "uf": "PE",
19
    "cep": "70011750",
20
    "cpf": "12345678909",
21
    "nome": "Francisco da Silva"
22
  },
23
  "recebedor": {
24
    "logradouro": "Rua 15 Numero 1200, Bairro São Luiz",
25
    "cidade": "São Paulo",

200Cobrança com vencimento revisada. A revisão deve ser incrementada em 1.

400Requisição com formato inválido.

403Requisição de participante autenticado que viola alguma regra de autorização.

404Recurso solicitado não foi encontrado.

503Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.