Pular para o conteúdo principal
Um parceiro pode chamar o plugin Payments com a sua própria credencial. Você restringe essa credencial a uma organização da Midaz. Isso é necessário quando um deploy de Payments atende várias organizações, ou quando um dos seus próprios clientes emite boletos e paga contas por conta própria. Todo parceiro de Payments precisa de um escopo.

Passo a passo

1

Escolha a organização em que o parceiro atua

O Payments tem uma restrição:A restrição aceita uma organização. Mais de um valor é recusado com 400 e IDE-0002.O ledger e as contas não são uma restrição do Payments. Veja O escopo do parceiro na Midaz não vale para o Payments.
2

Dê ao parceiro as permissões e o escopo

Crie o parceiro, ou altere-o, no Console ou com a API de Identity. O slug do produto é plugin-br-payments.
  • Adicione a entrada de escopo com a organização. 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 editor do Payments tem no seu tenant. Acima disso, o Access Manager recusa com IDE-1043.
Você pode dar a um parceiro estas ações: read, create e cancel no recurso boletos; read e create no recurso payments; e read no recurso dashboard.O recurso admin age sobre o tenant inteiro. O Access Manager recusa toda ação de admin com 400 e IDE-1056, e o Console marca a linha como Fora do escopo.
3

Crie a aplicação de Payments

Crie a aplicação do parceiro com o produto plugin-br-payments. 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.
4

Informe a organização em cada requisição

Toda requisição informa a organização no cabeçalho X-Organization-Id, que o Payments já exige nestas rotas. O valor precisa ser a organização do escopo do parceiro. Uma requisição sem ele é recusada.Um boleto, lote, série ou pagamento de outra organização responde 404, a mesma resposta de um ID que não existe: informe a organização a que o item pertence.
5

Confirme que funciona

Use a credencial do parceiro. Liste os boletos da organização do escopo do parceiro. A resposta é 200:
Envie a mesma requisição sem o cabeçalho, ou com outra organização. A resposta é 403 com PBP-0004.

O escopo do parceiro na Midaz não vale para o Payments

O Payments lança na Midaz com a sua própria credencial de máquina, não com o token do parceiro. Um escopo da Midaz que você dá ao parceiro não vale para esses lançamentos. O parceiro pode usar todos os ledgers e contas da sua organização que o Payments aceita.

Rotas que nenhum parceiro alcança

Um parceiro é recusado com 403 e PBP-0004 nestas rotas:
  • Toda rota sob /v1/admin.
  • POST /v1/payments/{id}/cancel.
As rotas administrativas configuram a integração do seu tenant inteiro. Use uma aplicação da sua própria instituição para elas e para o cancelamento de um pagamento.

Se algo falhar

O PBP-0004 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 organizações existem fora do seu escopo. Para as recusas ao criar ou alterar um parceiro, veja Códigos de erro no guia da API. Em um deploy BYOC, o Access Manager só sabe que o Payments aceita parceiros depois que o Payments publica a sua declaração de permissões. Veja Declaração de permissões.