Skip to main content
POST
Request settlement retry

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Idempotency key, max 255 characters.

Parâmetros de caminho

txid
string
obrigatório

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

Pattern: ^[a-zA-Z0-9]{26,35}$
data
string
obrigatório

Data prevista de liquidação da ordem de pagamento (YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$

Resposta

Created

ajusteDiaUtil
boolean
obrigatório
atualizacao
object[]
obrigatório

Histórico das mudanças de status da cobrança recorrente.

calendario
object
obrigatório
idRec
string
obrigatório
Pattern: ^[a-zA-Z0-9]{29}$
politicaRetentativa
enum<string>
obrigatório

Política de retentativa vigente para esta cobrança (congelada da Rec na criação).

Opções disponíveis:
NAO_PERMITE,
PERMITE_3R_7D
recebedor
object
obrigatório
revisao
integer<int64>
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
CRIADA,
ATIVA,
CONCLUIDA,
EXPIRADA,
REJEITADA,
CANCELADA
tentativas
object[]
obrigatório

Histórico de tentativas de liquidação.

txid
string
obrigatório
Pattern: ^[a-zA-Z0-9]{26,35}$
valor
object
obrigatório
atestacaoTitularidade
object
devedor
object
encerramento
object
infoAdicional
string
Maximum string length: 140