Skip to main content
PATCH
Revisar cobrança com vencimento

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

txid
string
obrigatório

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

Corpo

application/json
calendario
object

Controle de tempo da cobrança.

chave
string

Chave DICT do recebedor.

Maximum string length: 77
devedor
object

Devedor da cobrança.

infoAdicionais
object[] | null

Informações adicionais (máx 50).

loc
object

Referência de location.

solicitacaoPagador
string

Texto livre apresentado ao pagador.

Maximum string length: 140
status
enum<string>

Único valor aceito: REMOVIDA_PELO_USUARIO_RECEBEDOR (remove a cobrança).

Opções disponíveis:
REMOVIDA_PELO_USUARIO_RECEBEDOR
valor
object

Valores monetários da cobrança.

Resposta

OK

calendario
object
obrigatório
chave
string
obrigatório

Chave DICT do recebedor.

Maximum string length: 77
devedor
object
obrigatório
loc
object
obrigatório
location
string
obrigatório

Localização do payload.

Maximum string length: 77
pixCopiaECola
string
obrigatório

Pix Copia e Cola (BR Code) correspondente à cobrança.

Maximum string length: 512
recebedor
object
obrigatório
revisao
integer<int64>
obrigatório

Revisão da cobrança (inicia em 0).

status
enum<string>
obrigatório

Status do registro da cobrança.

Opções disponíveis:
ATIVA,
CONCLUIDA,
REMOVIDA_PELO_USUARIO_RECEBEDOR,
REMOVIDA_PELO_PSP
txid
string
obrigatório

Identificador da transação.

Pattern: [a-zA-Z0-9]{26,35}
valor
object
obrigatório
infoAdicionais
object[] | null
solicitacaoPagador
string
Maximum string length: 140