Payload Location

Crie, liste, consulte e desvincule locations (payloads) para reutilizar QR Codes em diferentes cobrancas.

Locations permitem reutilizar o mesmo QR Code para diferentes cobrancas. Voce cria uma location e depois a vincula a uma cobranca atraves do campo loc.id ao criar a cobranca. Isso e util para pontos de venda fixos, onde o QR Code impresso permanece o mesmo mas a cobranca associada muda a cada transacao.

Criar Location

POST/loc

Cria uma nova location de payload. A location gerada pode ser vinculada a uma cobranca imediata (cob) ou com vencimento (cobv).

Base URL: https://api.pix.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2
`Content-Type`	application/json	Tipo de conteudo da requisicao

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`tipoCob`	string	Obrigatorio	Tipo de cobranca associada a location. Valores aceitos: "cob" (cobranca imediata) ou "cobv" (cobranca com vencimento)

Exemplo de Request

{
  "tipoCob": "cob"
}

Exemplo de Response

{
  "id": 7890,
  "tipoCob": "cob",
  "criacao": "2025-01-20T14: 30: 00.000Z",
  "location": "pix.example.com/qr/v2/cobr/2a1b3c4d5e6f7a8b"
}

Exemplos de Codigo

curl -X POST https://api.pix.basspago.com.br/loc \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "tipoCob": "cob"
  }'

Listar Locations

GET/loc

Lista as locations de payload cadastradas. A consulta e paginada e permite filtrar por periodo e tipo de cobranca.

Base URL: https://api.pix.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Query

Nome	Tipo	Obrigatorio	Descricao
`inicio`	string	Obrigatorio	Data/hora de inicio do periodo de consulta (formato RFC 3339, ex: 2025-01-01T00:00:00Z)
`fim`	string	Obrigatorio	Data/hora de fim do periodo de consulta (formato RFC 3339, ex: 2025-01-31T23:59:59Z)
`tipoCob`	string	Opcional	Filtrar por tipo de cobranca: "cob" ou "cobv"
`paginacao.paginaAtual`	integer	Opcional	Numero da pagina atual (comeca em 0)
`paginacao.itensPorPagina`	integer	Opcional	Quantidade de itens por pagina

Exemplo de Response

{
  "parametros": {
    "inicio": "2025-01-01T00: 00:00Z",
    "fim": "2025-01-31T23: 59:59Z",
    "paginacao": {
      "paginaAtual": 0,
      "itensPorPagina": 100,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 3
    }
  },
  "loc": [
    {
      "id": 7890,
      "tipoCob": "cob",
      "criacao": "2025-01-20T14: 30: 00.000Z",
      "location": "pix.example.com/qr/v2/cobr/2a1b3c4d5e6f7a8b"
    },
    {
      "id": 7891,
      "tipoCob": "cobv",
      "criacao": "2025-01-21T09: 15: 00.000Z",
      "location": "pix.example.com/qr/v2/cobr/9z8y7x6w5v4u3t2s"
    }
  ]
}

Exemplos de Codigo

curl -X GET "https://api.pix.basspago.com.br/loc?inicio=2025-01-01T00:00:00Z&fim=2025-01-31T23:59:59Z" \
  -H "Authorization: Bearer {access_token}"

Consultar Location

GET/loc/{id}

Recupera uma location especifica pelo seu identificador. Retorna as informacoes da location incluindo dados da cobranca vinculada, se houver.

Base URL: https://api.pix.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Rota

Nome	Tipo	Descricao
`id`	string	Identificador da location

Exemplo de Response

{
  "id": 7890,
  "tipoCob": "cob",
  "criacao": "2025-01-20T14: 30: 00.000Z",
  "location": "pix.example.com/qr/v2/cobr/2a1b3c4d5e6f7a8b",
  "txid": "fc9a43e0b7e14b5a8c3d2f1e0a9b8c7d",
  "status": "ATIVA"
}

Exemplos de Codigo

curl -X GET https://api.pix.basspago.com.br/loc/7890 \
  -H "Authorization: Bearer {access_token}"

Desvincular Cobrança da Location

DELETE/loc/{id}/txid

Desvincula uma cobranca de uma location. A location permanece ativa e pode ser vinculada a outra cobranca posteriormente.

Base URL: https://api.pix.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Rota

Nome	Tipo	Descricao
`id`	string	Identificador da location

Exemplo de Response

{
  "id": 7890,
  "tipoCob": "cob",
  "criacao": "2025-01-20T14: 30: 00.000Z",
  "location": "pix.example.com/qr/cobr/2a1b3c4d5e6f7a8b"
}

Exemplos de Codigo

curl -X DELETE https://api.pix.basspago.com.br/loc/7890/txid \
  -H "Authorization: Bearer {access_token}"

O endpoint DELETE /loc/{id}/txid retorna 200 com o objeto PayloadLocation (sem o txid vinculado), e nao 204 No Content.