Skip to main content

Payments by biometrics

The following endpoints are responsible for Payments by biometrics


Attention!

To use the Automatic Pix features, you must have an Efí Business Digital Account.


Create enrollment​

This endpoint allows the creation of a new enrollment in the journey without redirection, enabling the registration of links with different account holders. These links can be used later to initiate payments, promoting greater flexibility in the process. The body of the request must include essential information about the payer: CPF or CNPJ and the idParticipante of the holding institution where the payer's account is located.

POST /v1/pagamentos-biometria/vinculos
Requires authorization for the scope: gn.opb.jwr.enrollment.write


Request

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

Responses

The Responses below represent Success(200) and consumption failures/errors.

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

Get a user's enrollment​

This endpoint retrieves all enrollments associated with the user provided. This endpoint allows you to query links using the mandatory CPF and, optionally, the CNPJ to filter results. The response contains a list of links that can be used for future operations, such as initiating payments and managing them.

GET /v1/pagamentos-biometria/vinculos
Requires authorization for the scope: gn.opb.jwr.enrollment.read


Responses

The Responses below represent Success(200) and consumption failures/errors.

{
  "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"
      }
    }
  ]
}

Revoke enrollment​

This endpoint allows you to revoke an enrollment in the journey without redirection.

PATCH /v1/pagamentos-biometria/vinculo
Requires authorization for the scope: gn.opb.jwr.enrollment.write


Request

{
  "identificadorVinculo": "urn:efi:ae71713f-875b-4af3-9d85-0bcb43288847",
  "motivo": "Encerramento de contrato de vinculo"
}

Responses

The responses below represent Success(200) and consumption failures/errors.

{
  "identificadorVinculo": "urn:efi:ae71713f-875b-4af3-9d85-0bcb43288847",
  "status": "revogado",
  "motivo": "Usuário solicitou a revogação do vinculo",
  "data": "2025-06-18"
}

Create payment through JSR​

This endpoint allows you to create a new payment in the JSR.

POST /v1/pagamentos-biometria/pix
Requires authorization for the scope: gn.opb.jwr.payment.write


Request


{
  "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"
  }
}

Responses

The Responses below represent Success(200) and consumption failures/errors.

{
  "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"
}

Get payments made through the JSR​

The endpoint in question is a search tool. It allows the user to search for a specific payment, for payments that have a specific status or for payments that do or do not meet a criterion within a certain period.

GET /v1/pagamentos-biometria/pix
Requires authorization for the scope: gn.opb.jwr.payment.read


Request

To obtain the query result, it is necessary to inform the parameters `inicio` and `fim`, as shown in the code snippet below. These parameters represent the date range within which the queried payments should be included.
/v1/pagamentos-biometria/pix?inicio=2022-05-01&fim=2022-12-30

Responses

The Responses below represent Success(200) and consumption failures/errors.

{
  "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"
        }
      ]
    }
  ]
}

Last updated on