Saltar al contenido principal
POST
End a declaration

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. An identical resend within 1 hour returns the original response, status included, with X-Idempotency-Replayed: true. Reusing the key with a divergent method, URL or body is PIX-0031 @ 412.

Required string length: 1 - 64

Parámetros de ruta

settled_participant_id
string<uuid>
requerido

id of the declaration, stable across its versions. Not a UUID is 400 PIX-0015.

Ejemplo:

"0193a7d0-1a2b-7c3d-8e4f-5a6b7c8d9e0f"

Cuerpo

application/json
validTo
string<date>
requerido

Last day the declaration is in force, inclusive, YYYY-MM-DD; required and never null.

Ejemplo:

"2027-01-31"

version
integer<int64>
requerido

Current version of the declaration, as its last response gave it; another version is 409 PIX-0728.

Rango requerido: x >= 1
Ejemplo:

1

Respuesta

OK

id
string<uuid>
requerido

Declaration id, stable across versions.

Ejemplo:

"0193a7d0-1a2b-7c3d-8e4f-5a6b7c8d9e0f"

ispb
string
requerido

ISPB of the indirect participant the tenant settles for.

Pattern: ^[0-9A-Z]{8}$
Ejemplo:

"23456789"

validFrom
string<date>
requerido

First day the declaration is in force.

Ejemplo:

"2026-11-01"

validTo
string<date> | null
requerido

Last day the declaration is in force, inclusive; null while it has no end.

Ejemplo:

"2027-01-31"

version
integer<int64>
requerido

Version of the declaration: 1 when declared, one more when it is ended.

Rango requerido: x >= 1
Ejemplo:

1

name
string | null

Name of the indirect participant, when declared.

Ejemplo:

"Exemplo Pagamentos IP S.A."