Pular para o conteúdo principal

Pagamentos por Biometria

Os endpoints a seguir são responsáveis pelos Pagamentos por Biometria


Atenção

As funcionalidades relacionadas aos Pagamentos por Biometria disponíveis nesta documentação são exclusivamente para fins de teste e não refletem transações financeiras reais.


Criar vínculo​

Este endpoint permite a criação de um novo vínculo na jornada sem redirecionamento, possibilitando o registro de vínculos com diferentes detentoras de conta. Esses vínculos poderão ser utilizados posteriormente para a iniciação de pagamentos, promovendo maior flexibilidade no processo. O corpo da requisição deve incluir informações essenciais sobre o pagador: CPF ou CNPJ e o idParticipante da instituição detentora onde a conta do pagador está localizada.

POST /v1/jsr/vinculos
Requer autorização para o escopo: gn.opb.jwr.enrollment.write


Requisição

{
  "pagador": {
    "idParticipante": "9f4cd202-8f2b-11ec-b909-0242ac120002",
    "cpf": "45204392050",
    "cnpj": "90293071000112"
  }
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "identificadorVinculo": "urn:efi:ae71713f-875b-4af3-9d85-0bcb43288847",
  "redirectURI": "https://efibank.com.br/create-enrollment?identifier=urn:efi:ae71713f-875b-4af3-9d85-0bcb43288847"
}

Consultar vínculos de um usuário​

Esse endpoint recupera todos os vínculos associados ao usuário informado. Este endpoint permite consultar os vínculos utilizando o CPF obrigatório e, opcionalmente, o CNPJ para filtrar resultados. A resposta contém uma lista de vínculos que podem ser utilizados para operações futuras, como a iniciação de pagamentos e gestão dos mesmos.

GET /v1/jsr/vinculos
Requer autorização para o escopo: gn.opb.jwr.enrollment.read


Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "vinculos": [
    {
      "identificador": "urn:efi:c0498e81-2c3a-4b29-931a-5c5ba2b1599a",
      "dataAutorizacao": "2025-01-01 15:23:00",
      "dataExpiraçao": "2025-01-01 15:23:00",
      "limiteDiario": "100000.12",
      "limiteTransacao": "100000.12",
      "conta": {
        "numero": "2788287",
        "agencia": "0001",
        "ispb": "090898356",
        "tipo": "corrente"
      },
      "participante": {
        "identificador": "9f4cd202-8f2b-11ec-b909-0242ac120002",
        "nome": "Efí",
        "descricao": "Descrição da marca",
        "logo": "https://www.sejaefi.com.br/logo.png"
      }
    }
  ]
}

Criar pagamento via Jornada sem Redirecionamento​

Este endpoint permite a criação de um novo pagamento na jornada sem redirecionamento.

POST /v1/jsr/pagamentos/pix
Requer autorização para o escopo: gn.opb.jwr.payment.write


Requisição


{
  "identificadorVinculo": "urn:efi:19ba4105-9ae2-4637-89f2-96506d3c8770",
  "favorecido": {
    "contaBanco": {
      "nome": "Lucas Silva",
      "documento": "17558266300",
      "codigoBanco": "09089356",
      "agencia": "0001",
      "conta": "654984",
      "tipoConta": "TRAN"
    },
    "chave": "2badfe30-d03b-4da1-9f2f-02b5dcef765c"
  },
  "pagamento": {
    "valor": "9.99",
    "codigoCidadeIBGE": "5300108",
    "infoPagador": "Churrasco",
    "idProprio": "6236574863254",
    "qrCode": "00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123ABCD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76",
    "identificadorTransacao": "E00038166201907261559y6j6"
  }
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "identificadorPagamento": "urn:efi:ae71713f-875b-4af3-9d85-0bcb43288847",
  "redirectURI": "https://open-finance.banco.com.br/authorize?request=eyJjd&redirect_uri=https://pub.opb.testegerencianet.com.br/callback&scope=openid%20pagamentos%20consent:urn:efi:fdf36ac8-f213-4057-bf2e-2ce7bd828abf&response_type=code%20id_token"
}

Consultar pagamentos feitos via Jornada sem Redirecionamento​

O endpoint em questão é uma ferramenta de pesquisa. Ele permite que o usuário busque por um pagamento específico, por pagamentos que possuem um status especifico ou por pagamentos que atendem ou não um critério dentro de um determinado período.

GET /v1/jsr/pagamentos/pix
Requer autorização para o escopo: gn.opb.jwr.payment.read


Requisição

Para obter o resultado da consulta é necessário informar os parâmetros inicio e fim, como exibido no trecho de código abaixo. Esses parâmetros representam o intervalo de datas em que as cobranças consultadas devem estar compreendidas.
/v1/jsr/pagamentos/pix?inicio=2022-05-01&fim=2022-12-30

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "vinculos": [
    {
      "identificadorPagamento": "urn:efi:49315a93-d39c-4564-9edb-9a73678dbdb1",
      "endToEndId": "E00038166201907261559y6j6",
      "valor": "1.99",
      "status": "aceito",
      "dataCriacao": "2022-04-29T11:55:03.000Z",
      "idProprio": "6236574863254",
      "devolucoes": [
        {
          "identificadorDevolucao": "D09089356202211111429d82ecc2ecde",
          "valor": "1.99",
          "status": "aceito",
          "dataCriacao": "2022-04-29T11:59:03.000Z"
        }
      ]
    }
  ]
}

Última atualização em