Regenerar pagamento

POST /api/v1/valepix/distributions/{distribution_id}/regenerate-payment

Gera novamente uma cobrança PIX ou BOLETO para uma distribuição em expired.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json
Content-Type: application/json

Path params

Parâmetro	Tipo	Obrigatório	Descrição
distribution_id	string	Sim	Identificador da distribuição em expired

Body

Campo	Tipo	Obrigatório	Descrição
payment_method	string	Sim	PIX ou BOLETO
payer_name	string	Não	Nome do pagador; usa os dados da empresa quando omitido
payer_document	string	Não	Documento do pagador; usa os dados da empresa quando omitido

Exemplo curl

curl --request POST \
  --url "https://routes.valepix.com.br/api/v1/valepix/distributions/$DISTRIBUTION_ID/regenerate-payment" \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --data '{
    "payment_method": "PIX",
    "payer_name": "Empresa Exemplo",
    "payer_document": "12345678000190"
  }'

Response

HTTP 200 OK.

{
  "success": "success",
  "data": {
    "batch_id": "00000000-0000-4000-8000-000000000901",
    "status": "PENDING",
    "transaction_id": "00000000-0000-4000-8000-000000000903",
    "payment_info": {
      "amount": 50000,
      "pix_copy_paste": "novo_codigo_pix",
      "pix_qr_code_url": "https://exemplo.test/novo-qr-code",
      "expiration_date": "2026-07-25T23:59:59Z"
    }
  }
}

Validações importantes

• A distribuição precisa estar em expired.
• A distribuição precisa ter sido finalizada anteriormente com uma cobrança regenerável.
• A operação cria uma nova transação e uma nova cobrança.
• Após o sucesso, consulte a distribuição e acompanhe o novo pagamento.

Erros comuns

HTTP	Quando acontece	Ação recomendada
400	Body ou dados do pagador inválidos	Corrigir os dados enviados
401	Token ausente, inválido, expirado ou revogado	Conferir o header Authorization
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
404	Distribuição não encontrada	Conferir o distribution_id e o ambiente
422	Distribuição fora de expired, cobrança original ausente ou método não suportado	Consultar a distribuição e usar PIX ou BOLETO
429	Limite de chamadas excedido	Reduzir a taxa de chamadas e aplicar backoff
500, 502, 503, 504	Falha temporária	Consultar a distribuição antes de repetir a chamada