Skip to main content
POST
End a declaration

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

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

Path Parameters

settled_participant_id
string<uuid>
required

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

Example:

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

Body

application/json
validTo
string<date>
required

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

Example:

"2027-01-31"

version
integer<int64>
required

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

Required range: x >= 1
Example:

1

Response

OK

id
string<uuid>
required

Declaration id, stable across versions.

Example:

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

ispb
string
required

ISPB of the indirect participant the tenant settles for.

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

"23456789"

validFrom
string<date>
required

First day the declaration is in force.

Example:

"2026-11-01"

validTo
string<date> | null
required

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

Example:

"2027-01-31"

version
integer<int64>
required

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

Required range: x >= 1
Example:

1

name
string | null

Name of the indirect participant, when declared.

Example:

"Exemplo Pagamentos IP S.A."