Retentar Cobrança

Disponível apenas em Sandbox

Este endpoint está disponível somente no ambiente Sandbox. Não há suporte para Pix Automático em produção no momento.

Use esta rota para agendar uma nova tentativa de liquidação de uma cobrança rejeitada.

POSTv3/automatic_pix/charges/:charge_id/retry

Importante

A retentativa só é aceita quando:

1. o cliente aceitou retentativas na autorização (is_retry_accepted igual a true);
2. o código de rejeição da cobrança original permite retentativa (veja quais rejeições permitem retentativa);
3. a nova data está dentro da janela permitida e o limite de tentativas não foi atingido.

Request Variable Path

Atributo	Tipo	Descrição
charge_id	string	ID Marlim da cobrança rejeitada.

Request Body Params

Atributo	Tipo	Descrição
date	date	Nova data de liquidação no formato YYYY-MM-DD.

Atenção

Valor, conta recebedora e descrição são copiados da cobrança original e não podem ser alterados na retentativa. Se precisar mudar algum desses dados, agende uma nova cobrança.

Response Object

Cada retentativa gera uma nova cobrança, com charge_id próprio. A rota retorna essa nova cobrança com os campos de Consultar Cobrança, com a nova data, has_retry igual a true e original_charge_id apontando para a cobrança original. A cobrança original também passa a ter has_retry igual a true. Guarde o novo charge_id para acompanhar a retentativa.

Error Object

Atributo	Tipo	Descrição
api_reference	string	URL para a documentação. Retornado nos erros de parâmetro.
errors	array	Array com todos os erros encontrados ao processar a requisição.
errors[][type]	string	Tipo de erro ocorrido.
errors[][message]	string	Mensagem detalhada do erro ocorrido.

Exemplos

Retentativa agendada

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/cHg4Tn8PqW1zLm6XbY2d/retry" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "date": "2026-12-08"
}'

Response200

{
  "charge_id": "rTy5Kp2NmB8vCx4ZqL7w",
  "authorization_id": "aUt7Hq2LmZ9xVb3KcR8s",
  "link_id": "pXq3Lk9TzR2mWb7NcA1e",
  "item_id": null,
  "current_status": "scheduled",
  "date": "2026-12-08",
  "amount": 65000,
  "description": "Mensalidade dezembro",
  "customer": {
    "document_number": "00099988877"
  },
  "end_to_end_id": null,
  "has_retry": true,
  "original_charge_id": "cHg4Tn8PqW1zLm6XbY2d",
  "error": null,
  "metadata": {},
  "date_created": "2026-12-05T10:12:00.000Z",
  "date_updated": "2026-12-05T10:12:01.000Z"
}

Data fora da janela

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/cHg4Tn8PqW1zLm6XbY2d/retry" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "date": "2026-12-15"
}'

Response400

{
  "api_reference": "https://docs.api.marlim.co/automatic-pix/charges/retry",
  "errors": [
    {
      "type": "date",
      "message": "The parameter [ date ] must be within 7 days of the original charge date."
    }
  ]
}

Cobrança não rejeitada

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/rTy5Kp2NmB8vCx4ZqL7w/retry" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "date": "2026-12-10"
}'

Response400

{
  "errors": [
    {
      "type": "status",
      "message": "Only charges with rejected status can be retried."
    }
  ]
}

Retentativa não aceita pelo cliente

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/dKl9Mn3BvC6xZa1SqW4e/retry" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "date": "2026-12-08"
}'

Response400

{
  "errors": [
    {
      "type": "is_retry_accepted",
      "message": "The customer did not accept retries in this authorization."
    }
  ]
}

Rejeição sem retentativa

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/fGh2Jk5LqP8wXc3VbN6m/retry" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "date": "2026-12-08"
}'

Response400

{
  "errors": [
    {
      "type": "error_code",
      "message": "Charges rejected with [ invalid_amount ] can not be retried. Schedule a new charge."
    }
  ]
}

Limite de tentativas

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/hJk7Lp4QwE1rTy9UiO2p/retry" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "date": "2026-12-08"
}'

Response400

{
  "errors": [
    {
      "type": "attempts",
      "message": "The limit of 3 retries for this charge was reached."
    }
  ]
}

Cobrança não encontrada

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/AABBCCDD/retry" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "date": "2026-12-08"
}'

Response404

{
  "errors": [
    {
      "type": "not_found",
      "message": "Charge with id [AABBCCDD] was not found"
    }
  ]
}