Skip to main content
PATCH
Update 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"

Corpo

application/json
action
string

Lifecycle transition; one of suspend, reactivate, close.

Exemplo:

"suspend"

delivery
object

New delivery endpoint and/or secret.

name
string

New display name (1..120 chars).

Exemplo:

"Indirect PSP Ltda"

qrCertificate
object

New own-QR-code certificate configuration. Absent leaves it unchanged. Accepted only when the indirect participants feature is enabled for the tenant (422 PIX-0111 otherwise).

Resposta

OK

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