⌘K

Criar Recorrência

Cria uma recorrência de Pix Automático. A recorrência nasce com status CRIADA e precisa ser autorizada pelo pagador por uma das jornadas de autorização.

Os campos valor.valorRec e valor.valorMinimoRecebedor são mutuamente exclusivos: informe apenas um deles. O envio dos dois campos na mesma requisição resulta em erro.

Na Jornada 3, informe o txid da cobrança imediata (cob) em ativacao.dadosJornada.txid para vincular a cobrança inicial à ativação da recorrência.

POST/rec

Cria uma nova recorrência de Pix Automático. Requer o escopo rec.write. Retorna 201 com o idRec gerado e o status CRIADA.

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

Headers

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

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`vinculo.contrato`	string	Obrigatorio	Identificador do contrato entre recebedor e pagador (até 35 caracteres)
`vinculo.devedor.cpf`	string	Obrigatorio	CPF do devedor (11 dígitos). Obrigatório para pessoa física; para pessoa jurídica utilize vinculo.devedor.cnpj
`vinculo.devedor.cnpj`	string	Opcional	CNPJ do devedor (14 dígitos), para pessoa jurídica. Utilize cpf ou cnpj, nunca ambos
`vinculo.devedor.nome`	string	Obrigatorio	Nome do devedor (até 140 caracteres)
`vinculo.objeto`	string	Opcional	Descrição do objeto da recorrência, para o pagador reconhecer o débito (até 35 caracteres)
`calendario.dataInicial`	string (YYYY-MM-DD)	Obrigatorio	Data prevista do primeiro pagamento da recorrência
`calendario.dataFinal`	string (YYYY-MM-DD)	Opcional	Data final da recorrência. Informe apenas para vigência pré-definida
`calendario.periodicidade`	enum	Obrigatorio	Periodicidade das cobranças: SEMANAL, MENSAL, TRIMESTRAL, SEMESTRAL ou ANUAL
`valor.valorRec`	string (\d{1,10}\.\d{2})	Opcional	Valor fixo de cada ciclo da recorrência (ex: "35.00")
`valor.valorMinimoRecebedor`	string (\d{1,10}\.\d{2})	Opcional	Valor mínimo aceito pelo recebedor por ciclo. Não pode coexistir com valorRec
`recebedor.convenio`	string	Opcional	Identificador de convênio do recebedor (até 60 caracteres)
`politicaRetentativa`	enum	Obrigatorio	Política de retentativa: NAO_PERMITE ou PERMITE_3R_7D (até 3 retentativas em 7 dias)
`loc`	int64	Opcional	Identificador de uma location de recorrência (locrec) previamente criada
`ativacao.dadosJornada.txid`	string	Opcional	txid da cobrança imediata vinculada à ativação. Obrigatório na Jornada 3

Exemplo de Request

{
  "vinculo": {
    "contrato": "63100862",
    "devedor": {
      "cpf": "45164632481",
      "nome": "Fulano de Tal"
    },
    "objeto": "Serviço de streaming de música"
  },
  "calendario": {
    "dataInicial": "2026-08-01",
    "dataFinal": "2027-08-01",
    "periodicidade": "MENSAL"
  },
  "valor": {
    "valorRec": "35.00"
  },
  "politicaRetentativa": "NAO_PERMITE",
  "loc": 108,
  "ativacao": {
    "dadosJornada": {
      "txid": "33beb661beda44a8928fef47dbeb2dc5"
    }
  }
}

Exemplo de Response

{
  "idRec": "RN1234567820260801abcdefghijk",
  "status": "CRIADA",
  "vinculo": {
    "contrato": "63100862",
    "devedor": {
      "cpf": "45164632481",
      "nome": "Fulano de Tal"
    },
    "objeto": "Serviço de streaming de música"
  },
  "calendario": {
    "dataInicial": "2026-08-01",
    "dataFinal": "2027-08-01",
    "periodicidade": "MENSAL"
  },
  "valor": {
    "valorRec": "35.00"
  },
  "politicaRetentativa": "NAO_PERMITE",
  "recebedor": {
    "cnpj": "01602606000113",
    "nome": "Empresa de Serviços SA"
  },
  "loc": {
    "criacao": "2026-07-19T10: 30: 00.000Z",
    "id": 108,
    "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
    "idRec": "RN1234567820260801abcdefghijk"
  },
  "ativacao": {
    "dadosJornada": {
      "tipoJornada": "JORNADA_3",
      "txid": "33beb661beda44a8928fef47dbeb2dc5"
    }
  },
  "atualizacao": [
    {
      "data": "2026-07-19T10: 30: 00.000Z",
      "nome": "CRIADA"
    }
  ]
}

Exemplos de Codigo

curl -X POST https://api.pix.basspago.com.br/rec \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "vinculo": {
      "contrato": "63100862",
      "devedor": {
        "cpf": "45164632481",
        "nome": "Fulano de Tal"
      },
      "objeto": "Serviço de streaming de música"
    },
    "calendario": {
      "dataInicial": "2026-08-01",
      "dataFinal": "2027-08-01",
      "periodicidade": "MENSAL"
    },
    "valor": {
      "valorRec": "35.00"
    },
    "politicaRetentativa": "NAO_PERMITE"
  }'