⌘K

Payload Location (locrec)

Crie, liste, consulte e desvincule locations de payload para QR Codes de recorrência do Pix Automático. As locations do tipo locrec possuem tipo fixo "rec".

Crie a location antes da recorrência e informe o id retornado no campo loc do POST /rec. Assim você pode reutilizar QR Codes impressos: o QR Code permanece o mesmo enquanto a recorrência vinculada à location pode mudar.

Criar Location de Recorrência

POST/locrec

Cria uma nova location de payload para recorrência. Retorna 201 com a location criada, que pode ser vinculada a uma recorrência posteriormente. Requer o escopo payloadlocationrec.write.

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

Headers

Header	Valor	Descricao
`Content-Type`	application/json	Tipo de conteúdo da requisição
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`convenio`	string	Opcional	Identificador de convênio associado à location (opcional)

Exemplo de Request

{
  "convenio": "123456"
}

Exemplo de Response

{
  "id": 108,
  "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
  "criacao": "2026-06-10T07: 10: 05.115Z"
}

Exemplos de Codigo

curl -X POST https://api.pix.basspago.com.br/locrec \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "convenio": "123456"
  }'

Listar Locations de Recorrência

GET/locrec

Lista as locations de payload de recorrência cadastradas. A consulta é paginada e permite filtrar por período, presença de idRec e convênio. Requer o escopo payloadlocationrec.read.

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 início do período de consulta (formato RFC 3339, ex: 2026-06-01T00:00:00Z)
`fim`	string	Obrigatorio	Data/hora de fim do período de consulta (formato RFC 3339, ex: 2026-06-30T23:59:59Z)
`idRecPresente`	boolean	Opcional	Filtrar por locations com (true) ou sem (false) recorrência vinculada
`convenio`	string	Opcional	Filtrar por identificador de convênio
`paginacao.paginaAtual`	integer	Opcional	Número da página atual (padrão 0)
`paginacao.itensPorPagina`	integer	Opcional	Quantidade de itens por página (padrão 100, máximo 1000)

Exemplo de Response

{
  "parametros": {
    "inicio": "2026-06-01T00: 00:00Z",
    "fim": "2026-06-30T23: 59:59Z",
    "paginacao": {
      "paginaAtual": 0,
      "itensPorPagina": 100,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 1
    }
  },
  "loc": [
    {
      "id": 108,
      "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
      "criacao": "2026-06-10T07: 10: 05.115Z",
      "idRec": "RN1234567820260801abcdefghijk"
    }
  ]
}

Exemplos de Codigo

curl -X GET "https://api.pix.basspago.com.br/locrec?inicio=2026-06-01T00:00:00Z&fim=2026-06-30T23:59:59Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100" \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}"

Consultar Location de Recorrência

GET/locrec/{id}

Recupera uma location de recorrência específica pelo seu identificador. Retorna 200 com os dados da location, incluindo o campo idRec se houver recorrência vinculada. Caso a location não exista, retorna 404. Requer o escopo payloadlocationrec.read.

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`	integer	Identificador da location

Exemplo de Response

{
  "id": 108,
  "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
  "criacao": "2026-06-10T07: 10: 05.115Z",
  "idRec": "RN1234567820260801abcdefghijk"
}

Exemplos de Codigo

curl -X GET https://api.pix.basspago.com.br/locrec/108 \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}"

Desvincular Recorrência da Location

DELETE/locrec/{id}/idRec

Desvincula a recorrência da location. Após a operação, a location deixa de resolver o payload da recorrência — porém o status da recorrência NÃO é alterado. Retorna 200 com a location sem o campo idRec. Requer o escopo payloadlocationrec.write.

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`	integer	Identificador da location

Exemplo de Response

{
  "id": 108,
  "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
  "criacao": "2026-06-10T07: 10: 05.115Z"
}

Exemplos de Codigo

curl -X DELETE https://api.pix.basspago.com.br/locrec/108/idRec \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}"