Cancelar um pagamento

Cancela o pagamento com base no ID fornecido. Um pagamento cancelado não gera mais envio de comunicações ao cliente. Caso seja um pagamento de assinatura, o sistema irá considerar o pagamento como pago a fim de determinar o status da assinatura.

Query Parameters

id integer required

O id do pagamento a ser cancelado

Responses

• 200
• 401
• 422
• 500

---

Pagamento cancelado com sucesso

application/json

Schema

Example (from schema)

---

Schema

id string

O ID do pagamento.

uuid string

O UUID do pagamento.

customer_id string

O ID do cliente do pagamento.

customer object

O cliente do pagamento.

subscription_id string

O ID da assinatura do pagamento.

subscription object

A assinatura do pagamento.

payment_link object

O link de pagamento.

items array

Os itens do pagamento.

allowed_methods array

Os métodos permitidos para o pagamento.

method string

O método do pagamento.

card_id string

O ID do cartão do pagamento.

card object

O cartão do pagamento.

digitable_line string

A linha digitável do pagamento.

pix_payload string

O payload do Pix do pagamento.

custom_data object

Os dados personalizados do pagamento.

value number

O valor do pagamento.

fine number

A multa do pagamento.

interest number

O juros do pagamento.

current_value number

O valor atual do pagamento.

current_fine number

A multa atual do pagamento.

current_interest number

O juros atual do pagamento.

installments number

As parcelas do pagamento.

status string

O status do pagamento.

retries_number number

O número de tentativas do pagamento.

was_last_retry boolean

Se foi a última tentativa do pagamento.

can_refund boolean

Se pode reembolsar o pagamento.

refunds array

Os reembolsos do pagamento.

receipts array

Os recibos do pagamento.

receipt_status string

O status do recibo do pagamento.

due_date date

A data de vencimento do pagamento.

ref_date date

A data de referência do pagamento.

paid_at date-time

A data e hora em que o pagamento foi pago.

company object

A empresa do pagamento.

charge_enabled boolean

A habilitação da cobrança do pagamento.

created_at date-time

A data e hora em que o pagamento foi criado.

updated_at date-time

A data e hora em que o pagamento foi atualizado.

url string

A URL do pagamento.

receipt_url string

A URL do recibo do pagamento.

{
  "id": "string",
  "uuid": "string",
  "customer_id": "string",
  "customer": {},
  "subscription_id": "string",
  "subscription": {},
  "payment_link": {},
  "items": [
    null
  ],
  "allowed_methods": [
    null
  ],
  "method": "string",
  "card_id": "string",
  "card": {},
  "digitable_line": "string",
  "pix_payload": "string",
  "custom_data": {},
  "value": 0,
  "fine": 0,
  "interest": 0,
  "current_value": 0,
  "current_fine": 0,
  "current_interest": 0,
  "installments": 0,
  "status": "string",
  "retries_number": 0,
  "was_last_retry": true,
  "can_refund": true,
  "refunds": [
    null
  ],
  "receipts": [
    null
  ],
  "receipt_status": "string",
  "due_date": "2024-10-02",
  "ref_date": "2024-10-02",
  "paid_at": "2024-10-02T18:42:13.216Z",
  "company": {},
  "charge_enabled": true,
  "created_at": "2024-10-02T18:42:13.216Z",
  "updated_at": "2024-10-02T18:42:13.216Z",
  "url": "string",
  "receipt_url": "string"
}

Não autorizado

application/json

Schema

Example (from schema)

Example

---

Schema

message string required

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

Erro na validação de dados

application/json

Schema

Example (from schema)

Example

---

Schema

message string required
errors object
property name* string

{
  "message": "string",
  "errors": {}
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": "The name field is required."
  }
}

Houve um erro inesperado

application/json

Schema

Example (from schema)

Example

---

Schema

message string required

{
  "message": "string"
}

{
  "message": "An unexpected error occurred"
}

Loading...