Pular para o conteúdo principal
GET
Get an indirect participant

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

indirectId
string
obrigatório

The indirect participant id.

Exemplo:

"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}$
Exemplo:

"87654321"

Resposta

OK

createdAt
string<date-time>
obrigatório

Creation timestamp (UTC).

delivery
object
obrigatório

Delivery endpoint (secret redacted).

directIspb
string
obrigatório

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

Exemplo:

"12345678"

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"

ledgerId
string
obrigatório

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

Exemplo:

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

messagingMode
string
obrigatório

Delivery mode.

Exemplo:

"raw"

name
string
obrigatório

Display name.

Exemplo:

"Indirect PSP Ltda"

organizationId
string
obrigatório

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

Exemplo:

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

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).