Skip to main content
POST
Close a reference month into an immutable report

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

Body

application/json
period
string
required

Reference month, YYYY-MM. Absent is 400 PIX-0002; not YYYY-MM, or a month before 2020-11, when Pix started, is 400 PIX-0003.

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$
Example:

"2026-10"

Response

OK

blocks
object
required

The ten APIX001 blocks in layout order, each with explicit coverage.

ispb
string
required

ISPB of the participant the report is for.

Example:

"12345678"

layoutVersion
string
required

APIX001 layout version the blocks follow.

Example:

"2.7"

period
string
required

Reference month, YYYY-MM.

Example:

"2026-10"

reportId
string
required

Immutable identifier of this report; a reopen and a new close produce another.

Example:

"0193a6f0-7c1e-7b4a-9d2e-5f6a7b8c9d0e"