v1

latestOpenAPI 3.0.0Apache 2.02026-07-1751129352.2 KB

CobV

Criar cobrança com vencimento.

Endpoint para criar uma cobrança com vencimento.

put/cobv/{txid}

Request body

chavestring required

Formato do campo chave

O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.
Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.
O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para iniciação do Pix.

solicitacaoPagadorstring

O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation <RmtInf>. O tamanho do campo <RmtInf> na pacs.008 está limitado a 140 caracteres.

Example request

{
  "calendario": {
    "dataDeVencimento": "2020-04-01"
  },
  "valor": {
    "desconto": {
      "descontoDataFixa": [
        {
          "data": "2020-04-01"
        }
      ]
    }
  }
}

Response

Cobrança com vencimento criada

txidstring required

Identificador da transação

O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.

Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.

revisaointeger required

O campo revisao

Denota a revisão da cobrança. Sempre começa em zero. Sempre varia em acréscimos de 1.

O incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado. O campo loc é uma exceção a esta regra.

Se em uma determinada alteração em uma cobrança, o único campo alterado for o campo loc, então esta operação não incrementa a revisão da cobrança.

O campo loc não ocasiona uma alteração na cobrança em si. Não é necessário armazenar histórico das alterações do campo loc para uma determinada cobrança. Para os outros campos da cobrança, registra-se histórico.

status'ATIVA' | 'CONCLUIDA' | 'REMOVIDA_PELO_USUARIO_RECEBEDOR' | 'REMOVIDA_PELO_PSP' required

Estado do registro da cobrança. Não se confunde com o estado da cobrança em si, ou seja, não guarda relação com o fato de a cobrança encontrar-se vencida ou expirada, por exemplo.

Os status são assim definidos:

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; e
REMOVIDO_PELO_PSP: indica que o PSP Recebedor solicitou a remoção do registro da cobrança.

pixCopiaEColastring

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.

chavestring required

Formato do campo chave

O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.
Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.
O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para iniciação do Pix.

solicitacaoPagadorstring

Example response

{
  "calendario": {
    "dataDeVencimento": "2020-04-01"
  },
  "loc": {
    "location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002"
  },
  "valor": {
    "desconto": {
      "descontoDataFixa": [
        {
          "data": "2020-04-01"
        }
      ]
    }
  }
}