Skip to main content
PATCH
Revisar cobranza inmediata

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

txid
string
requerido

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

Cuerpo

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

Opciones disponibles:
REMOVIDA_PELO_USUARIO_RECEBEDOR
valor
object

Valores monetários da cobrança.

Respuesta

OK

calendario
object
requerido
chave
string
requerido

Chave DICT do recebedor.

Maximum string length: 77
loc
object
requerido
location
string
requerido

Localização do payload.

Maximum string length: 77
pixCopiaECola
string
requerido

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

Maximum string length: 512
revisao
integer<int64>
requerido

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

status
enum<string>
requerido

Status do registro da cobrança.

Opciones disponibles:
ATIVA,
CONCLUIDA,
REMOVIDA_PELO_USUARIO_RECEBEDOR,
REMOVIDA_PELO_PSP
txid
string
requerido

Identificador da transação.

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