v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Cancelar carnê

Cancelamento de Carnê que está com status de "pending"

put/payment_booklets/{id}/cancel

Path parameters

idstring required

ID do carnê

Response

200

idstring

{"stackTrail":"paths:/payment_booklets/{id}/cancel:put:responses:200:content:application/json:schema:properties:external_reference","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/payment_booklets/{id}/cancel:put:responses:200:content:application/json:schema:properties:custom_instruction","oasType":"schema","type":"unknown"}

descriptionstring

price_centsinteger

started_atstring

finish_atstring

statusstring

{"stackTrail":"paths:/payment_booklets/{id}/cancel:put:responses:200:content:application/json:schema:properties:invoices","oasType":"schema","type":"unknown"}

payment_booklet_installmentsinteger

secure_urlstring

Example response

{
  "id": "6F10E0ACB4F3471CAE1356093E3999BB",
  "description": "Descrição da Capa do Carnê",
  "price_cents": 1000,
  "started_at": "2025-04-02T00:00:00-03:00",
  "finish_at": "2025-05-02T00:00:00-03:00",
  "status": "canceled",
  "customer": {
    "id": "796B9E7392444DAA971D3F1E0BE83F89",
    "datasource_id": "EA29CC4EFA5B4150BCF2C13857246168",
    "email": "jose_silva@teste.com",
    "created_at": "2024-01-02T10:28:13-03:00",
    "updated_at": "2024-04-29T12:03:42-03:00",
    "name": "José",
    "cc_emails": "jose_2@teste.com",
    "cpf_cnpj": "113.436.750-30",
    "zip_code": "01310100",
    "number": "1048",
    "complement": "55b",
    "street": "Avenida Paulista",
    "district": "Bela Vista",
    "phone": "999999999",
    "phone_prefix": "011"
  },
  "payment_booklet_installments": 2,
  "secure_url": "https://faturas.iugu.com/payment_booklet/6f10e0ac-b4f3-471c-ae13-56093e3999bb-d989"
}