⌘K

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

Na Jornada 1 do Pix Automático, após criar a recorrência você envia uma solicitação de confirmação. O PSP do pagador apresenta a solicitação ao usuário para aprovação, fora do fluxo de QR Code.

Criar Solicitação de Confirmação

POST/solicrec

Cria uma solicitação de confirmação para uma recorrência existente. Requer o scope solicrec.write. Retorna 201 com o idSolicRec gerado e o status inicial 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 solicrec.write)

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`idRec`	string	Obrigatorio	Identificador da recorrência (29 caracteres, padrão [a-zA-Z0-9]{29})
`calendario.dataExpiracaoSolicitacao`	string	Obrigatorio	Data/hora limite para o pagador responder à solicitação (formato RFC 3339)
`destinatario.agencia`	string	Opcional	Agência da conta do pagador (máximo 4 caracteres)
`destinatario.conta`	string	Obrigatorio	Conta do pagador (máximo 20 caracteres)
`destinatario.ispbParticipante`	string	Obrigatorio	ISPB do PSP do pagador (8 dígitos, padrão \d{8})
`destinatario.cpf`	string	Opcional	CPF do pagador. Obrigatório informar cpf ou cnpj (apenas um dos dois)
`destinatario.cnpj`	string	Opcional	CNPJ do pagador. Obrigatório informar cpf ou cnpj (apenas um dos dois)

Exemplo de Request

{
  "idRec": "RN123456782026080177825445612",
  "calendario": {
    "dataExpiracaoSolicitacao": "2026-08-20T12: 17: 11.926Z"
  },
  "destinatario": {
    "agencia": "2569",
    "conta": "550689",
    "cpf": "15231470190",
    "ispbParticipante": "91193552"
  }
}

Exemplo de Response

{
  "idSolicRec": "SC876456782026080177825445312",
  "idRec": "RN123456782026080177825445612",
  "calendario": {
    "dataExpiracaoSolicitacao": "2026-08-20T12: 17: 11.926Z"
  },
  "status": "CRIADA",
  "destinatario": {
    "agencia": "2569",
    "conta": "550689",
    "cpf": "15231470190",
    "ispbParticipante": "91193552"
  },
  "atualizacao": [
    {
      "data": "2026-08-01T10: 15: 00.000Z",
      "status": "CRIADA"
    }
  ],
  "recPayload": {
    "vinculo": {
      "contrato": "63100862",
      "devedor": {
        "cpf": "15231470190",
        "nome": "Fulano de Tal"
      },
      "objeto": "Serviço de streaming"
    },
    "calendario": {
      "dataInicial": "2026-08-15",
      "periodicidade": "MENSAL"
    },
    "recebedor": {
      "cnpj": "12345678000195",
      "nome": "Empresa Exemplo LTDA"
    },
    "valor": {
      "valorRec": "35.00"
    },
    "atualizacao": [
      {
        "data": "2026-08-01T10: 00: 00.000Z",
        "status": "CRIADA"
      }
    ]
  }
}

Exemplos de Codigo

curl -X POST https://api.pix.basspago.com.br/solicrec \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "idRec": "RN123456782026080177825445612",
    "calendario": {
      "dataExpiracaoSolicitacao": "2026-08-20T12:17:11.926Z"
    },
    "destinatario": {
      "agencia": "2569",
      "conta": "550689",
      "cpf": "15231470190",
      "ispbParticipante": "91193552"
    }
  }'

Só pode existir UMA solicitação de confirmação ativa por idRec — se já houver uma solicitação ativa para a recorrência, a API retorna erro 400. Além disso, a dataExpiracaoSolicitacao não pode ser anterior à data de criação da solicitação.

Consultar Solicitação de Confirmação

GET/solicrec/{idSolicRec}

Consulta uma solicitação de confirmação pelo idSolicRec. Requer o scope solicrec.read. Retorna 200 com a mesma estrutura da criação. Caso não exista, retorna 404 (SolicRecNaoEncontrada).

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

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2 (scope solicrec.read)

Parametros de Rota

Nome	Tipo	Descricao
`idSolicRec`	string	Identificador da solicitação de confirmação (29 caracteres)

Exemplo de Response

{
  "idSolicRec": "SC876456782026080177825445312",
  "idRec": "RN123456782026080177825445612",
  "calendario": {
    "dataExpiracaoSolicitacao": "2026-08-20T12: 17: 11.926Z"
  },
  "status": "ACEITA",
  "destinatario": {
    "agencia": "2569",
    "conta": "550689",
    "cpf": "15231470190",
    "ispbParticipante": "91193552"
  },
  "atualizacao": [
    {
      "data": "2026-08-01T10: 15: 00.000Z",
      "status": "CRIADA"
    },
    {
      "data": "2026-08-01T10: 15: 05.000Z",
      "status": "ENVIADA"
    },
    {
      "data": "2026-08-01T10: 15: 10.000Z",
      "status": "RECEBIDA"
    },
    {
      "data": "2026-08-02T09: 40: 00.000Z",
      "status": "ACEITA"
    }
  ],
  "recPayload": {
    "vinculo": {
      "contrato": "63100862",
      "devedor": {
        "cpf": "15231470190",
        "nome": "Fulano de Tal"
      },
      "objeto": "Serviço de streaming"
    },
    "calendario": {
      "dataInicial": "2026-08-15",
      "periodicidade": "MENSAL"
    },
    "recebedor": {
      "cnpj": "12345678000195",
      "nome": "Empresa Exemplo LTDA"
    },
    "valor": {
      "valorRec": "35.00"
    },
    "atualizacao": [
      {
        "data": "2026-08-01T10: 00: 00.000Z",
        "status": "CRIADA"
      }
    ]
  }
}

Exemplos de Codigo

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

Cancelar Solicitação de Confirmação

PATCH/solicrec/{idSolicRec}

Cancela uma solicitação de confirmação. Requer o scope solicrec.write. O único valor aceito no body é "CANCELADA". O cancelamento só é permitido quando o status atual da solicitação é CRIADA, ENVIADA ou RECEBIDA.

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 solicrec.write)

Parametros de Rota

Nome	Tipo	Descricao
`idSolicRec`	string	Identificador da solicitação de confirmação (29 caracteres)

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`status`	string	Obrigatorio	Único valor aceito: "CANCELADA"

Exemplo de Request

{
  "status": "CANCELADA"
}

Exemplo de Response

{
  "idSolicRec": "SC876456782026080177825445312",
  "idRec": "RN123456782026080177825445612",
  "calendario": {
    "dataExpiracaoSolicitacao": "2026-08-20T12: 17: 11.926Z"
  },
  "status": "CANCELADA",
  "destinatario": {
    "agencia": "2569",
    "conta": "550689",
    "cpf": "15231470190",
    "ispbParticipante": "91193552"
  },
  "atualizacao": [
    {
      "data": "2026-08-01T10: 15: 00.000Z",
      "status": "CRIADA"
    },
    {
      "data": "2026-08-01T10: 15: 05.000Z",
      "status": "ENVIADA"
    },
    {
      "data": "2026-08-02T11: 20: 00.000Z",
      "status": "CANCELADA"
    }
  ]
}

Exemplos de Codigo

curl -X PATCH https://api.pix.basspago.com.br/solicrec/SC876456782026080177825445312 \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "status": "CANCELADA"
  }'

Status da Solicitação

Status	Descrição
`CRIADA`	Solicitação registrada, ainda não enviada ao PSP do pagador
`ENVIADA`	Solicitação enviada ao PSP do pagador
`RECEBIDA`	PSP do pagador confirmou o recebimento da solicitação
`REJEITADA`	Pagador (ou seu PSP) rejeitou a solicitação de confirmação
`ACEITA`	Pagador aceitou a solicitação e a recorrência foi confirmada
`EXPIRADA`	Prazo definido em dataExpiracaoSolicitacao venceu sem resposta do pagador
`CANCELADA`	Solicitação cancelada pelo recebedor antes da resposta do pagador