Revisar cobrança imediata.

patch

https://api.pix-h.treeal.com/cob/{txid}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

txid

string

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.

Body Params

Dados para geração da cobrança.

Atributos comuns a todas entidades de 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

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.

status

string

enum

Allowed:

valor

object

valores monetários referentes à cobrança.

chave

string

length ≤ 77

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

length ≤ 140

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

≤ 50

Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.

Informações adicionais

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Identificador da transação

Formato do campo chave

200Cobrança imediata 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.