Pular para o conteúdo principal
Um parceiro pode chamar o Pix Lerian com a sua própria credencial. Você restringe essa credencial a algumas contas do seu tenant. Isso é necessário quando o parceiro atua para alguns dos seus clientes e não pode agir nas contas dos outros. Todo parceiro de Pix Lerian precisa de um escopo.

Passo a passo


1

Escolha os produtos que o parceiro usa

O Pix Lerian é composto de quatro produtos no Access Manager. Dê ao parceiro apenas os produtos de que ele precisa:O adaptador de conectividade não aceita parceiros. Apenas os serviços do Pix Lerian o chamam.
2

Escolha as contas em que o parceiro atua

O Pix Lerian tem uma restrição, a mesma nos quatro produtos:O Pix Lerian não tem restrição de organização nem de ledger. Cada tenant opera uma organização e um ledger da Midaz. A configuração do tenant os define, e nenhuma requisição os informa. Para restringir um parceiro a um ledger, dê a ele também um escopo na Midaz. Veja As regras do parceiro na Midaz valem para as suas chamadas.
3

Dê ao parceiro as permissões e o escopo

Crie o parceiro, ou altere-o, no Console ou com a API de Identity. Use os slugs de produto do primeiro passo. A restrição aceita várias contas.
  • Adicione a entrada de escopo accountId em cada produto do Pix Lerian que você der. Sem ela, o Access Manager recusa o parceiro com 400 e IDE-1060.
  • Confira os recursos e as ações. O máximo que você pode dar é o que o papel de editor de cada produto tem no seu tenant. Acima disso, o Access Manager recusa com IDE-1043.
Algumas escritas agem em rotas que não levam conta:
  • Os bloqueios de saldo.
  • A caixa de saída de notificações.
  • As rotas de operador que executam e recuperam trabalhos.
  • A recuperação de uma transferência ou de uma devolução: transfer-recovery e refund-recovery, ação post.
  • As configurações de runtime.
O Access Manager as recusa com 400 e IDE-1056, e o Console marca a linha como Fora do escopo.O Access Manager também recusa, com o mesmo código, as escritas que alteram uma chave, abrem uma recuperação de valores ou criam um pagamento recorrente. Veja Rotas que nenhum parceiro alcança.
4

Crie as aplicações de Pix Lerian

Crie as aplicações do parceiro com os produtos do Pix Lerian que você deu a ele. Veja Crie as aplicações do parceiro no guia da API, ou no Console. Envie o client ID e o client secret ao parceiro por um canal seguro.
5

Informe a conta em cada requisição

Toda requisição informa a conta em um campo que o Pix Lerian já tem. O valor precisa estar no escopo do parceiro. Um parceiro precisa enviar a conta em todas as rotas desta tabela, também onde o campo é opcional para outros chamadores. Uma requisição sem ela é recusada.Uma requisição que informa um registro de outra conta responde 404, como se o registro não existisse. Nada é lido ou alterado.
6

Confirme que funciona

Esta verificação supõe que o parceiro tem o recurso transfers com a ação get em plugin-br-pix-lerian-spi, e um escopo com uma ou mais contas. Use a credencial do parceiro. Liste as transferências de uma conta do escopo do parceiro. A resposta é 200:
Envie a mesma requisição com uma conta fora do escopo do parceiro. A resposta é 403 com PIX-0010.

As regras do parceiro na Midaz valem para as suas chamadas


Alguns produtos do Pix Lerian chamam a Midaz enquanto atendem a requisição do parceiro:
  • O SPI lança os débitos e os créditos no ledger, e lê a conta e o seu titular.
  • O DICT hub e o Pix Automático leem o titular e a conta no CRM embutido na Midaz.
Quando o parceiro também tem permissões na Midaz, a Midaz aplica o escopo do parceiro na Midaz a essas chamadas. Por exemplo, considere um parceiro restrito na Midaz à organização do tenant e a um ledger. Ele consegue iniciar e processar um cash-out de uma conta desse ledger. Com o mesmo parceiro restrito na Midaz a outro ledger, o Pix Lerian recusa a iniciação e o processamento com 403 e PIX-0005, e o saldo da conta não muda.
  • Um parceiro sem permissões na Midaz é decidido apenas pelas suas permissões e escopo no Pix Lerian.
  • Você pode dar ao parceiro as regras da Midaz no mesmo fluxo do Console, ou depois, no produto Midaz.
  • As varreduras agendadas, os callbacks do provedor e os outros trabalhos em segundo plano rodam sem parceiro. As regras do parceiro não se aplicam a eles.
Não conte com as regras da Midaz com um CRM 3.x independente. Se o seu deploy lê titulares de um CRM 3.x independente, esse CRM não aplica as regras do parceiro. Apenas o CRM embutido na Midaz as aplica.

Rotas que nenhum parceiro alcança


Um parceiro com escopo no Pix Lerian é recusado com 403 e PIX-0010 nas rotas que não levam conta:
  • SPI: todas as rotas de /spi/v1/balance-locks, as rotas de um pagamento agendado ou de uma recorrência (/spi/v1/scheduled-payments/{schedule_id} e /spi/v1/scheduled-payment-recurrences/{recurrence_id}, com as rotas abaixo delas), e as rotas de operador.
  • DICT hub: POST /dict-hub/v1/claims/{claim_id}/acknowledge, POST /dict-hub/v1/keys/check, as rotas de uma recuperação de valores, e as rotas de notificações de infração, devoluções, marcações de fraude e VSync.
  • COB hub: POST /cob-hub/v1/brcodes/decode, GET /cob-hub/v1/brcodes/static e GET /cob-hub/v1/brcodes/static/{id}.
  • Pix Automático: POST /pixauto/v1/payer/recurring-consents e POST /pixauto/v1/payer/recurring-consents/{recurring_consent_id}/revoke.
Essas rotas agem sobre registros que nenhuma conta informa. O Pix Lerian também recusa um parceiro, com a mesma resposta, em três rotas em que a conta da requisição não vincula o que a rota altera:
  • PATCH /dict-hub/v1/entries/{entry_id}: a requisição pode mover a chave para outra conta.
  • POST /dict-hub/v1/dict/funds-recoveries: a rota abre a recuperação sobre uma transação que a conta não vincula.
  • POST /pixauto/v1/payer/recurring-payments: a rota aceita o pagamento sob um consentimento que a conta não vincula.
O Pix Lerian também recusa um parceiro, com a mesma resposta, nas quatro rotas de recuperação do SPI. Isso vale também quando a requisição informa uma conta do escopo do parceiro:
  • POST /spi/v1/transfers/{id}/unblock e POST /spi/v1/transfers/{id}/credit.
  • POST /spi/v1/refunds/{id}/unblock e POST /spi/v1/refunds/{id}/credit.
A sua equipe de operações usa essas rotas para corrigir uma transação presa em processamento, ou um crédito que falhou no ledger. Elas agem pelo tenant inteiro, então a conta da requisição não as restringe. Use uma aplicação da sua própria instituição para todas essas rotas.

Se algo falhar


O PIX-0010 não diz se foram as permissões ou o escopo que recusaram a requisição. Isso é intencional: um parceiro não consegue usar uma recusa para descobrir quais contas existem fora do seu escopo. Uma alteração em um parceiro, como uma suspensão ou um novo escopo, vale a partir da próxima requisição dele, também com um token que ele já tem. Para todos os outros códigos, veja a lista de erros do Pix Lerian. Para as recusas ao criar ou alterar um parceiro, veja Códigos de erro no guia da API.