--- agentTools: projectIndex: https://docs.mundipagg.com/llms.txt --- # Cancelar fatura Com o verbo _HTTP DELETE_, através do identificador da fatura (`invoice_id`), este recurso possibilita realizar o cancelamento da fatura. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Mundipagg API", "version": "1" }, "servers": [ { "url": "https://api.mundipagg.com/core/v1" } ], "components": { "securitySchemes": { "sec0": { "type": "http", "scheme": "basic" } } }, "security": [ { "sec0": [] } ], "paths": { "/invoices/{invoice_id}": { "delete": { "summary": "Cancelar fatura", "description": "Com o verbo _HTTP DELETE_, através do identificador da fatura (`invoice_id`), este recurso possibilita realizar o cancelamento da fatura.", "operationId": "cancelar-fatura", "parameters": [ { "name": "invoice_id", "in": "path", "description": "Código da fatura.
Formato: `in_XXXXXXXXXXXXXXXX`.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"in_n87qwY1FA2SzwXDb\",\n \"code\": \"P47FWGIEZP\",\n \"url\": \"/invoices/in_n87qwY1FA2SzwXDb\",\n \"amount\": 1490,\n \"status\": \"canceled\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-04T00:00:00Z\",\n \"canceled_at\": \"2017-04-04T15:48:48Z\",\n \"created_at\": \"2017-04-04T15:40:28Z\",\n \"items\": [\n {\n \"name\": \"Nome - teste\",\n \"amount\": 1490,\n \"quantity\": 1,\n \"description\": \"Bola\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_J4wRXJ0U6ytZrpAx\",\n \"name\": \"Tony Star8k\",\n \"email\": \"tstark@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-09-28T21:04:37Z\",\n \"updated_at\": \"2017-04-04T15:08:20Z\"\n },\n \"subscription\": {\n \"id\": \"sub_KrmEXBxHVIRAJxDG\",\n \"code\": \"KERZFJ6TQZ\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T15:10:01Z\",\n \"updated_at\": \"2017-04-04T15:10:01Z\"\n },\n \"cycle\": {\n \"id\": \"cycle_WE1ZYoX7uEfbRar4\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"end_at\": \"2017-05-03T23:59:59Z\",\n \"billing_at\": \"2017-05-04T00:00:00Z\"\n },\n \"charge\": {\n \"id\": \"ch_NnLXBY2sXxs0Z3Oy\",\n \"code\": \"KERZFJ6TQZ-01\",\n \"gateway_id\": \"453b685d-33aa-4fd9-a926-afd78dce2832\",\n \"status\": \"canceled\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-04T00:00:00Z\",\n \"paid_at\": \"2017-04-04T15:40:30Z\",\n \"canceled_at\": \"2017-04-04T15:48:48Z\",\n \"created_at\": \"2017-04-04T15:40:28Z\",\n \"updated_at\": \"2017-04-04T15:48:48Z\",\n \"last_transaction\": {\n \"id\": \"tran_jJ0n4JJsbKu88mL1\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"gateway_id\": \"ab76139e-2c3b-40a0-89ed-98d451821c0c\",\n \"amount\": 1490,\n \"status\": \"voided\",\n \"success\": true,\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"MUNDI\",\n \"acquirer_tid\": \"532840\",\n \"acquirer_nsu\": \"805131\",\n \"acquirer_auth_code\": \"557586\",\n \"operation_type\": \"cancel\",\n \"credit_card\": {\n \"id\": \"card_pEYq7rDbFeiW8V6k\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2016-11-16T17:02:39Z\",\n \"updated_at\": \"2016-12-29T12:03:24Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\" \n }\n },\n \"created_at\": \"2017-04-04T15:48:48Z\",\n \"updated_at\": \"2017-04-04T15:48:48Z\"\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "in_n87qwY1FA2SzwXDb" }, "code": { "type": "string", "example": "P47FWGIEZP" }, "url": { "type": "string", "example": "/invoices/in_n87qwY1FA2SzwXDb" }, "amount": { "type": "integer", "example": 1490, "default": 0 }, "status": { "type": "string", "example": "canceled" }, "payment_method": { "type": "string", "example": "credit_card" }, "due_at": { "type": "string", "example": "2017-04-04T00:00:00Z" }, "canceled_at": { "type": "string", "example": "2017-04-04T15:48:48Z" }, "created_at": { "type": "string", "example": "2017-04-04T15:40:28Z" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Nome - teste" }, "amount": { "type": "integer", "example": 1490, "default": 0 }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "description": { "type": "string", "example": "Bola" } } } }, "customer": { "type": "object", "properties": { "id": { "type": "string", "example": "cus_J4wRXJ0U6ytZrpAx" }, "name": { "type": "string", "example": "Tony Star8k" }, "email": { "type": "string", "example": "tstark@avengers.com" }, "delinquent": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2016-09-28T21:04:37Z" }, "updated_at": { "type": "string", "example": "2017-04-04T15:08:20Z" } } }, "subscription": { "type": "object", "properties": { "id": { "type": "string", "example": "sub_KrmEXBxHVIRAJxDG" }, "code": { "type": "string", "example": "KERZFJ6TQZ" }, "start_at": { "type": "string", "example": "2017-04-04T00:00:00Z" }, "interval": { "type": "string", "example": "month" }, "interval_count": { "type": "integer", "example": 1, "default": 0 }, "billing_type": { "type": "string", "example": "postpaid" }, "next_billing_at": { "type": "string", "example": "2017-05-04T00:00:00Z" }, "payment_method": { "type": "string", "example": "credit_card" }, "currency": { "type": "string", "example": "BRL" }, "statement_descriptor": { "type": "string", "example": "Spotify" }, "installments": { "type": "integer", "example": 1, "default": 0 }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "example": "2017-04-04T15:10:01Z" }, "updated_at": { "type": "string", "example": "2017-04-04T15:10:01Z" } } }, "cycle": { "type": "object", "properties": { "id": { "type": "string", "example": "cycle_WE1ZYoX7uEfbRar4" }, "start_at": { "type": "string", "example": "2017-04-04T00:00:00Z" }, "end_at": { "type": "string", "example": "2017-05-03T23:59:59Z" }, "billing_at": { "type": "string", "example": "2017-05-04T00:00:00Z" } } }, "charge": { "type": "object", "properties": { "id": { "type": "string", "example": "ch_NnLXBY2sXxs0Z3Oy" }, "code": { "type": "string", "example": "KERZFJ6TQZ-01" }, "gateway_id": { "type": "string", "example": "453b685d-33aa-4fd9-a926-afd78dce2832" }, "status": { "type": "string", "example": "canceled" }, "currency": { "type": "string", "example": "BRL" }, "payment_method": { "type": "string", "example": "credit_card" }, "due_at": { "type": "string", "example": "2017-04-04T00:00:00Z" }, "paid_at": { "type": "string", "example": "2017-04-04T15:40:30Z" }, "canceled_at": { "type": "string", "example": "2017-04-04T15:48:48Z" }, "created_at": { "type": "string", "example": "2017-04-04T15:40:28Z" }, "updated_at": { "type": "string", "example": "2017-04-04T15:48:48Z" }, "last_transaction": { "type": "object", "properties": { "id": { "type": "string", "example": "tran_jJ0n4JJsbKu88mL1" }, "transaction_type": { "type": "string", "example": "credit_card" }, "funding_source": { "type": "string", "example": "prepaid" }, "gateway_id": { "type": "string", "example": "ab76139e-2c3b-40a0-89ed-98d451821c0c" }, "amount": { "type": "integer", "example": 1490, "default": 0 }, "status": { "type": "string", "example": "voided" }, "success": { "type": "boolean", "example": true, "default": true }, "acquirer_name": { "type": "string", "example": "simulator" }, "acquirer_affiliation_code": { "type": "string", "example": "MUNDI" }, "acquirer_tid": { "type": "string", "example": "532840" }, "acquirer_nsu": { "type": "string", "example": "805131" }, "acquirer_auth_code": { "type": "string", "example": "557586" }, "operation_type": { "type": "string", "example": "cancel" }, "credit_card": { "type": "object", "properties": { "id": { "type": "string", "example": "card_pEYq7rDbFeiW8V6k" }, "first_six_digits": { "type": "string", "example": "542501" }, "last_four_digits": { "type": "string", "example": "8229" }, "brand": { "type": "string", "example": "Amex" }, "holder_name": { "type": "string", "example": "Tony Stark" }, "exp_month": { "type": "integer", "example": 1, "default": 0 }, "exp_year": { "type": "integer", "example": 2018, "default": 0 }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "example": "2016-11-16T17:02:39Z" }, "updated_at": { "type": "string", "example": "2016-12-29T12:03:24Z" }, "billing_address": { "type": "object", "properties": { "line_1": { "type": "string", "example": "10880, Malibu Point, Malibu Central" }, "zip_code": { "type": "string", "example": "90265" }, "city": { "type": "string", "example": "Malibu" }, "state": { "type": "string", "example": "CA" }, "country": { "type": "string", "example": "US" } } } } }, "created_at": { "type": "string", "example": "2017-04-04T15:48:48Z" }, "updated_at": { "type": "string", "example": "2017-04-04T15:48:48Z" } } } } } } } } } }, "412": { "description": "412", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"This invoice cannot be canceled.\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "This invoice cannot be canceled." } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "csharp", "code": "using MundiAPI.PCL;\nusing System.Web.Mvc;\n\nnamespace MundipaggTest.Controllers {\n\n public class HomeController : Controller {\n\n public ActionResult Index() {\n\n // Secret key fornecida pela Mundipagg\n string basicAuthUserName = \"SUA_CHAVE_SECRETA\";\n // Senha em branco. Passando apenas a secret key\n string basicAuthPassword = \"\";\n\n var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);\n\n string invoiceId = \"in_n87qwY1FA2SzwXDb\";\n\n var response = client.Invoices.CancelInvoice(invoiceId);\n\n return View();\n }\n}\n}", "name": "SDK C#" } ], "samples-languages": [ "csharp" ] } } } }, "x-readme": { "headers": [], "explorer-enabled": false, "proxy-enabled": false }, "x-readme-fauxas": true, "_id": "5aba89f6b169810058a71e9a:5aba89f6b169810058a71ecb" } ```