Cobrança - Criar cobrança

post

https://example.com/pix/direto/forintegration/v1/cob

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".

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

https://www.bcb.gov.br/estabilidadefinanceira/pix

Body Params

Dados para geração da cobrança.

calendario

object

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

devedor

object

required

Os campos aninhados 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. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar, efetivamente, o pagamento do documento. Não é permitido que o campo devedor.cpf e campo devedor.cnpj estejam preenchidos ao mesmo tempo. Se o campo devedor.cnpj está preenchido, então o campo devedor.cpf não pode estar preenchido, e vice-versa. Se o campo devedor.nome está preenchido, então deve existir ou um devedor.cpf ou um campo devedor.cnpj preenchido.

valor

object

required

chave

string

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.

solicitacaoPagador

string | null

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.

infoAdicionais

array of objects | null

infoAdicionais

Responses

Formato do campo chave

201Cobrança criada com sucesso.

400Ocorreu um erro ao tentar criar a cobrança.