Payload Locations

The following set of endpoints is intended to handle configuration and removal of locations for payload usage.

Create payload location

Endpoint to create a payload location. Required to send the tipoCob attribute with the value COB or COBV in the request body.

POST /v2/loc

Requires authorization for the scope: payloadlocation.write

Request

COB

{
  "tipoCob": "cob"
}

COBV

{
  "tipoCob": "cobv"
}

Responses

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

🟢 201

{
  "id": 66,
  "location": "qrcodes-pix.gerencianet.com.br/v2/7796e273b8e447c2b2c0ac2c58fe1a13",
  "tipoCob": "cob",
  "criacao": "2021-01-15T20:13:39.462Z"
}

🔴 400

{
  "nome": "json_invalido",
  "mensagem": "Valores ou tipos de campo inválidos",
  "erros": [
    {
      "chave": "enum",
      "caminho": ".body.tipoCob",
      "mensagem": "deve ser igual a um dos valores predefinidos"
    }
  ]
}

Get registered locations

Endpoint to retrieve registered locations.

GET /v2/loc

Requires authorization for the scope: payloadlocation.read

Request

To obtain the result of the location query, it is necessary to provide the parameters inicio and fim, as shown in the code snippet below. These parameters restrict the results to the locations within that date range.

/v2/loc/?inicio=2020-10-22T16:01:35Z&fim=2020-10-23T16:01:35Z

Responses

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

🟢 200

{
  "parametros": {
    "inicio": "2022-01-22T16:01:35.000Z",
    "fim": "2024-01-22T16:01:35.000Z",
    "paginacao": {
      "paginaAtual": 0,
      "itensPorPagina": 100,
      "quantidadeDePaginas": 3,
      "quantidadeTotalDeItens": 215
    }
  },
  "loc": [
    {
      "id": 1,
      "location": "qrcodes-pix.gerencianet.com.br/v2/05a9c9f346294ea1be67fb3dbac0fb9c",
      "tipoCob": "cob",
      "criacao": "2022-11-12T18:42:05.000Z"
    },
    {
      "id": 2,
      "location": "qrcodes-pix.gerencianet.com.br/v2/cobv/ba942526a50746cfae28e8d9af89afd0",
      "tipoCob": "cobv",
      "criacao": "2022-11-12T18:32:10.000Z",
      "txid": "31a0baG77448041d64352h4523459"
    },
    {
      "id": 3,
      "location": "qrcodes-pix.gerencianet.com.br/v2/de2fe49560c64a5fb70aa8249853279f",
      "tipoCob": "cob",
      "criacao": "2022-11-12T18:25:36.000Z",
      "txid": "31a0ba6a7a80g8d64352345334e5h7"
    }
  ]
}

🔴 400

{
  "nome": "valor_invalido",
  "mensagem": "Campo de data fim deve ser maior ou igual ao campo de data inicio"
}

Retrieve payload location

Endpoint to retrieve payload location

GET /v2/loc/:id

Requires authorization for the scope: payloadlocation.read

Responses

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

🟢 200

{
  "id": 7716,
  "txid": "fda9460fe04e4f129b72863ae57ee22f",
  "location": "pix.example.com/qr/v2/cobv/2353c790eefb11eaadc10242ac120002",
  "tipoCob": "cobv",
  "criacao": "2020-03-11T21:19:51.013Z"
}

🔴 400

{
  "nome": "location_nao_encontrada",
  "mensagem": "Nenhuma location encontrado para o identificador informado"
}

Generate QR Code from location

Endpoint to Generate QR Code from a location.

GET /v2/loc/:id/qrcode

Requires authorization for the scope: payloadlocation.read

Responses

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

Attention: The Preview link only works for Pix charges issued in a production environment.

🟢 200

{
  "qrcode": "00020101021226990014BR.GOV.BCB.PIX2577qrcodes-pix.gerencianet.com.br/bolix/v2/cobv/0000000000000000000000000000GERENCIANET SA6010OURO PRETO62070503***63047CB1", // BRCode ou copia e cola
  "imagemQrcode": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmc vMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0NSA0NSIgc2hhcGUtcmVuZGVyaW5nPSJjcmlzcEVkZ2VzIj48cGF0aCBmaWxsPSIjZmZmZmZmIiBkPSJNMCAwaDQ1djQ1SD..." ,
  "linkVisualizacao": "https://pix.sejaefi.com.br/cob/pagar/c0a68af7ece6468cbb8e120e29a27cb5"
}

🔴 400

{
  "nome": "location_nao_encontrada",
  "mensagem": "Nenhuma location encontrado para o identificador informado"
}

Responsive Link for Pix Charge

Discover the responsive link for Pix charges

This link aims to facilitate the sharing of Pix payments issued via API, displaying payment details, as well as the image of the QR Code and Pix Copy and Paste. More over! You can customize it using the logo and primary color defined in the settings of your account.

Learn more

To obtain this link for your Pix payment issued via API, simply access the API response at the payment creation endpoint and copy the generated location ID.

Then, you should consume the QR Code endpoint using the copied ID: https://pix.api.efipay.com.br/v2/loc/:id/qrcode

In the endpoint, locate the linkVisualizacao field and copy the generated URL.

That's it! With this generated URL, just send it to whoever is going to pay, as shown in the example below:

Example Links:
Immediate charge: https://pix.sejaefi.com.br/cob/pagar/c0a68af7ece6468cbb8e120e29a27cb5
Due charge: https://pix.sejaefi.com.br/cobv/pagar/3d89b1ae52604ed5b8accc78f3abd0aa

Attention: These links only work for Pix payments issued in the production environment.

Unlink a txid from location

Endpoint used to unlink a charge from a location.

If successfully executed, the loc entity will no longer have a txid, as it did before the call. Additionally, the cob or cobv entity associated with the unlinked txid will also no longer have a location. This operation does not change the status of the cob or cobv in question.

DELETE /v2/loc/:id/txid

Requires authorization for the scope: payloadlocation.write

Responses

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

🟢 200

{
  "id": 2316,
  "location": "qrcodes-pix.gerencianet.com.br/v2/a8534e273ecb47d3ac30613104544466",
  "tipoCob": "cob",
  "criacao": "2020-05-31T19:39:54.013Z"
}

🔴 400

{
  "nome": "location_nao_encontrada",
  "mensagem": "Nenhuma location encontrado para o identificador informado"
}