Skip to main content
PUT
Withdraw a competência's early-payment suspension

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default.

Example:

"idem-antecipacao-excluir-0001"

Path Parameters

numero_contrato
string
required

Rail contract number of an averbação belonging to the authenticated tenant.

Required string length: 2 - 15
Example:

"1997123478"

competencia
string
required

The suspended competência to withdraw, yyyyMM.

Pattern: ^[0-9]{6}$
Example:

"202611"

Response

OK

contrato
string
required

The contract number the rail confirmed the operation against.

Example:

"1997123478"

mensagem
string
required

The rail's own message.

Example:

"Antecipacao de parcela realizada com sucesso"