Pular para o conteúdo principal
API docs by Redocly

Pix Location (1.0.0)

Download OpenAPI specification:Download

Pix Location

pixLocation

Endpoints to manage Pix Locations and QR code generation

Get Pix location QR code information

Retrieve Pix location information and generate QR code data based on the location type and access token. This endpoint returns JOSE (JSON Object Signing and Encryption) formatted data for QR code generation.

path Parameters
locType
required
string
Enum: "cob" "cobv" "rec"

Type of Pix location

pixUrlAccessToken
required
string

Access token for the Pix location

query Parameters
codMun
string

Municipality code for location-specific data

DPP
string

Additional location parameter

Responses

Request samples 

const http = require('https');

const options = {
  method: 'GET',
  hostname: '',
  port: null,
  path: '%3Cname%3E.indireto.woovi-indireto.dev/location/qr/v2/%7BlocType%7D/%7BpixUrlAccessToken%7D?codMun=SOME_STRING_VALUE&DPP=SOME_STRING_VALUE',
  headers: {}
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on('data', function (chunk) {
    chunks.push(chunk);
  });

  res.on('end', function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Response samples

Content type
application/json
{
  • "error": "A cobrança em questão não foi encontrada para a location requisitada"
}

Create a new Pix location

Create a new Pix location with the specified type. The service will generate a unique access token and return the complete location information including the QR code URL.

Request Body schema: application/json
required
type
required
string
Enum: "cob" "cobv" "rec"

Type of Pix location to create

Responses

Request samples

Content type
application/json
{
  • "type": "cob"
}

Response samples

Content type
application/json
{
  • "location": {
    }
}