Obter payload JSON para cobrança com vencimento

get https://api.pix.voluti.com.br/cobv/{pixUrlAccessToken}

Use este endpoint quando o usuário devedor escaneia o QR Code dinâmico gerado pelo recebedor, ele é direcionado para um endpoint específico. Esta URL retorna uma estrutura JWS contendo os detalhes da transação.

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyIsImtpZCI6IjIwMTEtMDQtMjkiLCJqa3UiOiJodHRwczovL3Rvb2xzLmlldGYub3JnL2h0bWwvcmZjNzUxNyIsIng1dCI6IkFwcGVuZGl4QUV4YW1wbGVBMUpXS1NSc2FLZXkifQ.eyJjYWxlbmRhcmlvIjp7ImNyaWFjYW8iOiIyMDIwLTA5LTE1VDE5OjM5OjU0LjAxM1oiLCJhcHJlc2VudGFjYW8iOiIyMDIwLTA0LTAxVDE4OjAwOjAwWiIsImV4cGlyYWNhbyI6IjM2MDAifSwidHhpZCI6ImZjOWE0MzY2ZmYzZDQ5NjRiNWRiYzZjOTFhODcyMmQzIiwicmV2aXNhbyI6IjMiLCJzdGF0dXMiOiJBVElWQSIsInZhbG9yIjp7Im9yaWdpbmFsIjoiNTAwLjAwIn0sImNoYXZlIjoiNzQwN2M5YzgtZjc4Yi0xMWVhLWFkYzEtMDI0MmFjMTIwMDAyIiwic29saWNpdGFjYW9QYWdhZG9yIjoiSW5mb3JtYXIgY2FydGFvIGZpZGVsaWRhZGUiLCJpbmZvQWRpY2lvbmFpcyI6W3sibm9tZSI6InF1YW50aWRhZGUiLCJ2YWxvciI6IjIifV19.qI7NUrYkwcgXmyoyOjt2YLQyhxH-lPdr3xQ7RId9TDXZ-MlWmPJkUScjuo1Nz_EvlSotbWDGOxErBXHeTLHOQM-9T7lBmG5iw6uEX7L5U72XiganIm80EZCFD1vBPq9j89i4cP2U2Yv21TTt8JLhjA57KHLOSlj-KB5UAKCH-MX3AORFcrXFrYL2rrSQDe-lFNtdyPRwLQHIrhkQ6RR2FPhynzUG0401LScS9mWLLYbYzhzwtP5lk07Ryf4MZq86ihmOLFZXkIiW7pbSd8QfD5Dvj28XebLQi_bam9wInqKB--57_N741BskCN_TXf0EHbQ1qjNTgiT8Y1GIrA4pFA

Conforme pode-se verificar no exemplo acima, o objeto JWS apresenta três fragmentos separados pelo caractere . (ponto). São eles: header, payload e signature.

Nota:

Para garantir a segurança no acesso a essas URLs, é crucial seguir as orientações detalhadas no Manual de Segurança do Pix, disponível para consulta neste link.

Responses

Response body

object

calendario

object

required

Os campos contidos sob o identificador de calendário organizam informações sobre o 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.

apresentacao

date-time

required

Timestamp que indica o momento em que o payload JSON que representa a cobrança foi recuperado. Ou seja, idealmente, é o momento em que o usuário realizou a captura do QR Code para verificar os dados de pagamento. 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)

devedor

required

Os campos contidos sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento.

cpf ou cnpj: A cobrança pode ter um CPF ou um CNPJ como devedor. Não é permitido preencher ambos ao mesmo tempo.
nome: Se o nome do devedor estiver preenchido, deve existir um CPF ou CNPJ preenchido.

recebedor

object

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

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.

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.

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

Todos os campos que indicam valores monetários obedecem ao pattern \d{1,10}.\d{2}. O separador decimal é o caractere ponto. Não é aplicável utilizar separador de milhar. Exemplos de valores aderentes ao padrão: “1.00”, “123.99”, “123456789.23

original

string

Valor original da cobrança.

multa

string

Multa aplicada à cobrança

juros

string

Juro aplicado à cobrança

abatimento

string

Abatimento aplicado à cobrança

desconto

string

Descontos aplicados à cobrança

final

string

required

Valor final da cobrança.

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


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.pix.voluti.com.br/cobv/pixUrlAccessToken \
3
     --header 'accept: application/jose'


xxxxxxxxxx
37
}
1
{
2
  "calendario": {
3
    "criacao": "2020-09-15T19:39:54.013Z",
4
    "apresentacao": "2020-04-01T18:00:00Z",
5
    "dataDeVencimento": "2020-12-31",
6
    "validadeAposVencimento": 30
7
  },
8
  "devedor": {
9
    "cnpj": "56989000019533",
10
    "nome": "Empresa de Alimentos SA"
11
  },
12
  "recebedor": {
13
    "logradouro": "Rua 20 Numero 70, Bairro Luz",
14
    "cidade": "Belo Horizonte",
15
    "uf": "MG",
16
    "cep": "55120750",
17
    "cnpj": "58900633120711",
18
    "nome": "Empresa de Abastecimento SA"
19
  },
20
  "txid": "fc9a4366ff3d4964b5dbc6c91a8722d3",
21
  "revisao": 3,
22
  "status": "ATIVA",
23
  "valor": {
24
    "original": "123.45",
25
    "multa": "15.00",

200

400Requisição com formato inválido.

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.