Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Cobrança - Cliente

Cobrança - Criar cobrança

Atualmente no payload da response desta API não é retornada a informação do QRCode, em decorrência disto é aconselhada a utilização do endpoint desenvolvido no modelo do BS2, disponibilizado no menu "Recebimentos".<br /><br>Caso seja do interesse do cliente a utilização desta API, para obtenção do QRCode é necessário criá-lo seguindo orientações do BACEN<br /><br>https://www.bcb.gov.br/estabilidadefinanceira/pix

post/pix/direto/forintegration/v1/cob

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 nullable

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 . O tamanho do campo na pacs.008 está limitado a 140 caracteres.

Response

Cobrança criada com sucesso.

status'ATIVA' | 'CONCLUIDA' | 'REMOVIDA_PELO_USUARIO_RECEBEDOR' | 'REMOVIDA_PELO_PSP'
txIdstring nullable

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

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

locationstring nullable

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

chavestring nullable

O campo chave, obrigatório, 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.

solicitacaoPagadorstring nullable

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 . O tamanho do campo na pacs.008 está limitado a 140 caracteres.