API Reference

Revisar cobrança com vencimento

patch
https://api.pix.voluti.com.br/cobv/

Use este endpoint para revisar uma cobrança com vencimento.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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.
Body Params

Dados para geração da cobrança.

Atributos comuns a todas entidades de Cobrança

calendario
object

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

devedor

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

loc
object

Identificador da localização do payload.

string
enum
Defaults to REMOVIDA_PELO_USUARIO_RECEBEDOR

Estado do registro da cobrança com status unico.

  • REMOVIDO_PELO_USUARIO_RECEBEDOR: Indica que o usuário recebedor solicitou a remoção do registro da cobrança.
Allowed:
valor
object

Valores monetários.

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

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
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated almost 2 years ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated almost 2 years ago