Saltar al contenido principal
GET
Get an indirect participant

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

indirectId
string
requerido

The indirect participant id.

Ejemplo:

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

Parámetros de consulta

directIspb
string

The ISPB of the direct participant this indirect is addressed as - the one it rides. OPTIONAL: omit it and the indirect is addressed whichever participant it rides, exactly as before. Named, the indirect has to be mounted on that participant, or the answer is 404 PIX-0147 and nothing is read or changed; an ISPB this deployment does not act as is 422 PIX-0128, whether or not the indirect exists. It is ROUTING DATA you supply, never a credential, and a token confined to one direct participant has to name it here. Sending it empty (directIspb=) reads the same as omitting it.

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

"87654321"

Respuesta

OK

createdAt
string<date-time>
requerido

Creation timestamp (UTC).

delivery
object
requerido

Delivery endpoint (secret redacted).

directIspb
string
requerido

ISPB of the direct participant this indirect mounts on — recorded at registration and never changed.

Ejemplo:

"12345678"

indirectId
string
requerido

The indirect participant id (routing identifier).

Ejemplo:

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

ispb
string
requerido

The indirect PSP's ISPB.

Ejemplo:

"12345678"

ledgerId
string
requerido

The Midaz ledger inside that organization the @pi account was created in. Read-only.

Ejemplo:

"019fb9b6-8ed1-7964-86e6-b421f711e62a"

messagingMode
string
requerido

Delivery mode.

Ejemplo:

"raw"

name
string
requerido

Display name.

Ejemplo:

"Indirect PSP Ltda"

organizationId
string
requerido

The Midaz organization of that direct participant: the books this indirect's @pi account lives in. Read-only.

Ejemplo:

"019fb9b6-7593-7667-abe9-3b087192747b"

piAccountAlias
string
requerido

The derived @pi_{ispb} Midaz account alias.

Ejemplo:

"@pi_12345678"

provisioning
object
requerido

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

qrCertificate
object
requerido

Own-QR-code certificate configuration.

status
string
requerido

Lifecycle status.

Ejemplo:

"ACTIVE"

updatedAt
string<date-time>
requerido

Last-update timestamp (UTC).