⌘K

Pix Automático (Recorrências)

O Pix Automático permite receber pagamentos recorrentes com débito automático via Pix. O pagador autoriza a recorrência uma única vez e as cobranças seguintes são liquidadas automaticamente a cada ciclo, sem nova ação do pagador.

Base URL para todos os endpoints de Pix Automático: https://api.pix.basspago.com.br — a mesma do Cash In. Utilize os mesmos certificados mTLS e o mesmo fluxo de token OAuth2 (POST /oauth/token, expiração de 300 segundos), com os escopos rec.read e rec.write.

Como funciona

1Criar a recorrência (POST /rec)

2Pagador autoriza a recorrência (uma das 4 jornadas)

3Receber confirmação via webhook (recorrência APROVADA)

4Criar a cobrança recorrente a cada ciclo (PUT /cobr/{txid})

5Liquidação automática na data de vencimento

6Retentativa em caso de falha (opcional)

Jornadas de Autorização

A autorização do pagador pode ocorrer por uma de quatro jornadas, definidas pelo Bacen. A jornada determina se há QR Code e se existe uma cobrança inicial vinculada à ativação da recorrência.

Jornada	Autorização	QR Code	Cobrança inicial
1	Notificação fora do ecossistema Pix (via solicrec)	Não	Não
2	Leitura de QR Code de recorrência	Simples	Não
3	Leitura de QR Code composto	Composto	Cobrança imediata (cob)
4	Leitura de QR Code composto	Composto	Cobrança com vencimento (cobv)

Jornada 1: POST /rec seguido de POST /solicrec (o PSP do pagador notifica o cliente).
Jornada 2: POST /rec e depois GET /rec/{idRec} sem txid — o QR Code simples é retornado em dadosQR.
Jornada 3: POST /rec, criação de uma cobrança imediata (cob) e GET /rec/{idRec}?txid={txid} para gerar o QR Code composto.
Jornada 4: igual à Jornada 3, porém com uma cobrança com vencimento (cobv).
Pós-ativação: monitore os webhooks de recorrência (webhookrec) e crie as cobranças recorrentes via PUT /cobr/{txid} a cada ciclo.

Status

Recorrência (rec)

Ciclo de vida: CRIADA → APROVADA | REJEITADA | EXPIRADA | CANCELADA.

Status	Descrição
`CRIADA`	Recorrência criada, aguardando autorização do pagador.
`APROVADA`	Recorrência autorizada pelo pagador. Cobranças recorrentes podem ser criadas.
`REJEITADA`	Recorrência rejeitada pelo pagador ou pelo PSP do pagador.
`EXPIRADA`	Prazo de autorização expirou sem confirmação do pagador.
`CANCELADA`	Recorrência cancelada pelo recebedor, pelo pagador ou por um dos PSPs.

Solicitação de Confirmação (solicrec)

Status	Descrição
`CRIADA`	Solicitação de confirmação criada.
`ENVIADA`	Solicitação enviada ao PSP do pagador.
`RECEBIDA`	Solicitação recebida pelo PSP do pagador.
`REJEITADA`	Solicitação rejeitada pelo pagador.
`ACEITA`	Solicitação aceita pelo pagador. A recorrência é aprovada.
`EXPIRADA`	Solicitação expirou sem resposta do pagador.
`CANCELADA`	Solicitação cancelada.

Cobrança Recorrente (cobr)

Status	Descrição
`CRIADA`	Cobrança recorrente criada.
`ATIVA`	Cobrança agendada para liquidação na data de vencimento.
`CONCLUIDA`	Cobrança liquidada com sucesso.
`EXPIRADA`	Cobrança não liquidada dentro do prazo (incluindo eventuais retentativas).
`REJEITADA`	Cobrança rejeitada pelo PSP do pagador.
`CANCELADA`	Cobrança cancelada antes da liquidação.

Formato do idRec

O idRec é o identificador único da recorrência, com 29 caracteres no formato:

RAxxxxxxxxyyyyMMddkkkkkkkkkkk

Parte	Descrição
`R`	Caractere fixo "R".
`A`	Indicador de retentativa: "R" (permite retentativa após o vencimento) ou "N" (não permite).
`xxxxxxxx`	ISPB do agente (8 dígitos).
`yyyyMMdd`	Data de criação da recorrência.
`kkkkkkkkkkk`	Sequencial alfanumérico (11 caracteres).