⌘K

Criar Cobrança Recorrente

Cria a cobrança de um ciclo da recorrência (cobr). A cada período da recorrência confirmada, você emite uma cobrança que será liquidada automaticamente na data de vencimento.

Criar Cobrança com txid Próprio

PUT/cobr/{txid}

Cria uma cobrança recorrente com txid definido por você. Requer o scope cobr.write. Retorna 201 com a cobrança criada no 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 (scope cobr.write)

Parametros de Rota

Nome	Tipo	Descricao
`txid`	string	Identificador da transação, gerado por você (padrão [a-zA-Z0-9]{26,35})

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`idRec`	string	Obrigatorio	Identificador da recorrência (29 caracteres)
`calendario.dataDeVencimento`	string	Obrigatorio	Data prevista para a liquidação da cobrança (formato YYYY-MM-DD)
`valor.original`	string	Obrigatorio	Valor da cobrança em BRL (padrão \d{1,10}\.\d{2}, ex: "35.00")
`ajusteDiaUtil`	boolean	Obrigatorio	Se true, empurra a liquidação para o próximo dia útil, considerando os feriados do município do devedor
`recebedor.conta`	string	Obrigatorio	Conta do recebedor que receberá a liquidação (máximo 20 caracteres)
`recebedor.tipoConta`	string	Obrigatorio	Tipo da conta do recebedor: CORRENTE, POUPANCA ou PAGAMENTO
`recebedor.agencia`	string	Opcional	Agência da conta do recebedor (máximo 4 caracteres)
`devedor.email`	string	Opcional	E-mail do devedor
`devedor.logradouro`	string	Opcional	Logradouro do devedor (máximo 200 caracteres)
`devedor.cidade`	string	Opcional	Cidade do devedor (máximo 200 caracteres)
`devedor.uf`	string	Opcional	UF do devedor (máximo 2 caracteres)
`devedor.cep`	string	Opcional	CEP do devedor (máximo 8 caracteres)
`infoAdicional`	string	Opcional	Texto livre exibido na fatura do pagador (máximo 140 caracteres)

Exemplo de Request

{
  "idRec": "RR1234567820260801abcdefghijk",
  "infoAdicional": "Serviço de streaming — ciclo 08/2026",
  "calendario": {
    "dataDeVencimento": "2026-08-15"
  },
  "valor": {
    "original": "35.00"
  },
  "ajusteDiaUtil": true,
  "devedor": {
    "cep": "89256140",
    "cidade": "Uberlândia",
    "email": "cliente@mail.com",
    "logradouro": "Alameda Franco 1056",
    "uf": "MG"
  },
  "recebedor": {
    "agencia": "9708",
    "conta": "012682",
    "tipoConta": "CORRENTE"
  }
}

Exemplo de Response

{
  "txid": "3136957d93134f2184b369e8f1c0729d",
  "idRec": "RR1234567820260801abcdefghijk",
  "status": "CRIADA",
  "politicaRetentativa": "PERMITE_3R_7D",
  "infoAdicional": "Serviço de streaming — ciclo 08/2026",
  "calendario": {
    "criacao": "2026-08-01T10: 30: 00.000Z",
    "dataDeVencimento": "2026-08-15"
  },
  "valor": {
    "original": "35.00"
  },
  "ajusteDiaUtil": true,
  "devedor": {
    "cep": "89256140",
    "cidade": "Uberlândia",
    "email": "cliente@mail.com",
    "logradouro": "Alameda Franco 1056",
    "uf": "MG"
  },
  "recebedor": {
    "agencia": "9708",
    "conta": "012682",
    "tipoConta": "CORRENTE"
  },
  "atualizacao": [
    {
      "data": "2026-08-01T10: 30: 00.000Z",
      "status": "CRIADA"
    }
  ]
}

Exemplos de Codigo

curl -X PUT https://api.pix.basspago.com.br/cobr/3136957d93134f2184b369e8f1c0729d \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "idRec": "RR1234567820260801abcdefghijk",
    "infoAdicional": "Serviço de streaming — ciclo 08/2026",
    "calendario": {
      "dataDeVencimento": "2026-08-15"
    },
    "valor": {
      "original": "35.00"
    },
    "ajusteDiaUtil": true,
    "devedor": {
      "cep": "89256140",
      "cidade": "Uberlândia",
      "email": "cliente@mail.com",
      "logradouro": "Alameda Franco 1056",
      "uf": "MG"
    },
    "recebedor": {
      "agencia": "9708",
      "conta": "012682",
      "tipoConta": "CORRENTE"
    }
  }'

Só pode existir uma cobrança ativa (status diferente de REJEITADA ou CANCELADA) por idRec em cada ciclo da recorrência. Tentar criar outra cobrança para o mesmo ciclo retorna erro 400.

A cobrança deve respeitar o calendário e a periodicidade definidos na recorrência. Além disso, a dataDeVencimento não pode ser anterior à data de criação da cobrança.

Criar Cobrança com txid Gerado pelo PSP

POST/cobr

Idêntico ao PUT /cobr/{txid}, porém o txid é gerado automaticamente pelo PSP e retornado na resposta. O body e a resposta seguem exatamente a mesma estrutura. Requer o scope cobr.write. Retorna 201.

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 (scope cobr.write)

Exemplo de Request

{
  "idRec": "RR1234567820260801abcdefghijk",
  "infoAdicional": "Serviço de streaming — ciclo 08/2026",
  "calendario": {
    "dataDeVencimento": "2026-08-15"
  },
  "valor": {
    "original": "35.00"
  },
  "ajusteDiaUtil": true,
  "recebedor": {
    "agencia": "9708",
    "conta": "012682",
    "tipoConta": "CORRENTE"
  }
}

Exemplo de Response

{
  "txid": "8f4c1b2a9e0d4f6b8c7a5e3d2f1a0b9c",
  "idRec": "RR1234567820260801abcdefghijk",
  "status": "CRIADA",
  "politicaRetentativa": "PERMITE_3R_7D",
  "infoAdicional": "Serviço de streaming — ciclo 08/2026",
  "calendario": {
    "criacao": "2026-08-01T10: 30: 00.000Z",
    "dataDeVencimento": "2026-08-15"
  },
  "valor": {
    "original": "35.00"
  },
  "ajusteDiaUtil": true,
  "recebedor": {
    "agencia": "9708",
    "conta": "012682",
    "tipoConta": "CORRENTE"
  },
  "atualizacao": [
    {
      "data": "2026-08-01T10: 30: 00.000Z",
      "status": "CRIADA"
    }
  ]
}

Exemplos de Codigo

curl -X POST https://api.pix.basspago.com.br/cobr \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "idRec": "RR1234567820260801abcdefghijk",
    "infoAdicional": "Serviço de streaming — ciclo 08/2026",
    "calendario": {
      "dataDeVencimento": "2026-08-15"
    },
    "valor": {
      "original": "35.00"
    },
    "ajusteDiaUtil": true,
    "recebedor": {
      "agencia": "9708",
      "conta": "012682",
      "tipoConta": "CORRENTE"
    }
  }'