Skip to main content
POST
Register an indirect participant

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
name
string
obrigatório

Display name of the indirect participant (1..120 chars).

Exemplo:

"Indirect PSP Ltda"

delivery
object

Delivery endpoint + signing secret.

ispb
string

The indirect PSP's own ISPB (exactly 8 digits). Required for MVP flows.

Exemplo:

"12345678"

messagingMode
string

Delivery mode; the MVP supports 'raw' (JD-pure passthrough).

Exemplo:

"raw"

Resposta

Created

createdAt
string<date-time>
obrigatório

Creation timestamp (UTC).

delivery
object
obrigatório

Delivery endpoint (secret redacted).

indirectId
string
obrigatório

The indirect participant id (routing identifier).

Exemplo:

"018f2b7c-0000-7000-8000-000000000000"

ispb
string
obrigatório

The indirect PSP's ISPB.

Exemplo:

"12345678"

messagingMode
string
obrigatório

Delivery mode.

Exemplo:

"raw"

name
string
obrigatório

Display name.

Exemplo:

"Indirect PSP Ltda"

piAccountAlias
string
obrigatório

The derived @pi_{ispb} Midaz account alias.

Exemplo:

"@pi_12345678"

provisioning
object
obrigatório

Legacy provisioning state. Always present as an object; its failedStep is always null for a row registered by this service.

qrCertificate
object
obrigatório

Own-QR-code certificate configuration.

status
string
obrigatório

Lifecycle status.

Exemplo:

"ACTIVE"

updatedAt
string<date-time>
obrigatório

Last-update timestamp (UTC).