API Reference

Cobrança com vencimento - Revisar

patch
https://example.com/pix/direto/forintegration/v1/cobv/
Path Params
string
required

Identificador da transação([a-zA-Z0-9]{26,35}).

Body Params

Dados para revisã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
int64

Identificador da localização do payload.

string
enum
Allowed:
valor
object

Dados do valor do qrcode.

string | null

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.

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

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

infoAdicionais
Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Updated 23 days ago

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

Updated 23 days ago