Cancelar 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 cancelar uma cobrança agendada que ainda não foi liquidada. A autorização continua ativa e pode receber novas cobranças.

POSTv3/automatic_pix/charges/:charge_id/cancel

Request Variable Path

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

Request Body Params

Atributo	Tipo	Descrição
canceled_by	string	CPF ou CNPJ de quem solicitou o cancelamento, somente números. Deve ser o mesmo documento do pagador da cobrança.

Response Object

Retorna a cobrança com os campos de Consultar Cobrança, com current_status igual a canceled.

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

Cobrança cancelada

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/cHg4Tn8PqW1zLm6XbY2d/cancel" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "canceled_by": "00099988877"
}'

Response200

{
  "charge_id": "cHg4Tn8PqW1zLm6XbY2d",
  "authorization_id": "aUt7Hq2LmZ9xVb3KcR8s",
  "link_id": "pXq3Lk9TzR2mWb7NcA1e",
  "item_id": "MENSALIDADE_2026_12",
  "current_status": "canceled",
  "date": "2026-12-05",
  "amount": 65000,
  "description": "Mensalidade dezembro",
  "customer": {
    "document_number": "00099988877"
  },
  "end_to_end_id": null,
  "has_retry": false,
  "original_charge_id": null,
  "error": null,
  "metadata": {},
  "date_created": "2026-11-25T17:33:06.364Z",
  "date_updated": "2026-11-28T09:40:00.000Z"
}

Cobrança já liquidada

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/rTy5Kp2NmB8vCx4ZqL7w/cancel" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "canceled_by": "00099988877"
}'

Response400

{
  "errors": [
    {
      "type": "status",
      "message": "Only charges with pending or scheduled status can be canceled."
    }
  ]
}

Documento diferente do pagador

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/cHg4Tn8PqW1zLm6XbY2d/cancel" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "canceled_by": "00011122233"
}'

Response400

{
  "api_reference": "https://docs.api.marlim.co/automatic-pix/charges/cancel",
  "errors": [
    {
      "type": "canceled_by",
      "message": "The parameter [ canceled_by ] must be the document number of the charge payer."
    }
  ]
}

Cobrança não encontrada

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/charges/AABBCCDD/cancel" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "canceled_by": "00099988877"
}'

Response404

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