Skip to main content
GET
Get an indirect participant

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

indirectId
string
required

The indirect participant id.

Example:

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

Response

OK

createdAt
string<date-time>
required

Creation timestamp (UTC).

delivery
object
required

Delivery endpoint (secret redacted).

directIspb
string
required

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

Example:

"12345678"

indirectId
string
required

The indirect participant id (routing identifier).

Example:

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

ispb
string
required

The indirect PSP's ISPB.

Example:

"12345678"

ledgerId
string
required

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

Example:

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

messagingMode
string
required

Delivery mode.

Example:

"raw"

name
string
required

Display name.

Example:

"Indirect PSP Ltda"

organizationId
string
required

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

Example:

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

piAccountAlias
string
required

The derived @pi_{ispb} Midaz account alias.

Example:

"@pi_12345678"

provisioning
object
required

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

qrCertificate
object
required

Own-QR-code certificate configuration.

status
string
required

Lifecycle status.

Example:

"ACTIVE"

updatedAt
string<date-time>
required

Last-update timestamp (UTC).