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
accountIdem cada produto do Pix Lerian que você der. Sem ela, o Access Manager recusa o parceiro com400eIDE-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.
- 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-recoveryerefund-recovery, açãopost. - As configurações de runtime.
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 Envie a mesma requisição com uma conta fora do escopo do parceiro. A resposta é
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: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.
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.
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/staticeGET /cob-hub/v1/brcodes/static/{id}. - Pix Automático:
POST /pixauto/v1/payer/recurring-consentsePOST /pixauto/v1/payer/recurring-consents/{recurring_consent_id}/revoke.
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.
POST /spi/v1/transfers/{id}/unblockePOST /spi/v1/transfers/{id}/credit.POST /spi/v1/refunds/{id}/unblockePOST /spi/v1/refunds/{id}/credit.
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.
