Pular para o conteúdo principal
POST
Declare an indirect participant the tenant settles

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

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

Corpo

application/json
ispb
string
obrigatório

ISPB of the indirect participant the tenant settles for, eight digits or uppercase letters; the tenant's own ISPB is 422 PIX-0719.

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

"23456789"

validFrom
string<date>
obrigatório

First day the declaration is in force, YYYY-MM-DD.

Exemplo:

"2026-11-01"

clientRequestId
string

Client key of the declaration, unique per tenant: a resend with the same body answers the declaration it made, another body is 409 PIX-0717. Not returned in the response.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._:-]+$
Exemplo:

"sp-2026-11-23456789"

name
string

Name of the indirect participant, at most 140 characters.

Maximum string length: 140
Exemplo:

"Exemplo Pagamentos IP S.A."

Resposta

Created

id
string<uuid>
obrigatório

Declaration id, stable across versions.

Exemplo:

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

ispb
string
obrigatório

ISPB of the indirect participant the tenant settles for.

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

"23456789"

validFrom
string<date>
obrigatório

First day the declaration is in force.

Exemplo:

"2026-11-01"

validTo
string<date> | null
obrigatório

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

Exemplo:

"2027-01-31"

version
integer<int64>
obrigatório

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

Intervalo obrigatório: x >= 1
Exemplo:

1

name
string | null

Name of the indirect participant, when declared.

Exemplo:

"Exemplo Pagamentos IP S.A."