Cancelar Fatura

DELETE

https://api.tryplopay.com/invoices

💡

Escopo Necessário: invoice.update

Neste endpoint, você poderá CANCELAR uma fatura.

CAMPO	TIPO	OBRIGATORIO	DESCRIÇÃO	VALORES
id	STRING	SIM	ID DA FATURA

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200200 - Sucesso

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://api.tryplopay.com/invoices' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "payment": {
        "id": ""
    }
}'

Response Example

{
    "date": "2023-12-01 02:23:57",
    "success": true,
    "error": false,
    "type": "invoice",
    "api": {
        "by": "TRYPLOPAY.com",
        "version": "1.9",
        "updated": "2024-10-05"
    },
    "tipo": "invoice",
    "req": null,
    "fatura": {
        "moeda": "BRL",
        "id": "17014082271",
        "invoice_id": "99D3A2A36F0E41BDA2E12965526F81F1",
        "token": null,
        "cartao": {
            "tid": null,
            "token": null,
            "bin": null,
            "numero": null,
            "bandeira": null
        },
        "criacao": "2023-12-01 02:23:47",
        "vencimento": {
            "dia": "2023-12-02",
            "original": "2023-12-02"
        },
        "assinatura": {
            "id": null
        },
        "secure": {
            "id": "99d3a2a3-6f0e-41bd-a2e1-2965526f81f1-53dc",
            "url": "https://faturas.iugu.com/99d3a2a3-6f0e-41bd-a2e1-2965526f81f1-53dc"
        },
        "parcelas": 1,
        "produtos": [
            {
                "id": "3B595714060540A5BFBE40C1113C5D6C",
                "description": "Teste",
                "price_cents": 1200,
                "quantity": 1,
                "created_at": "2023-12-01T02:23:47-03:00",
                "updated_at": "2023-12-01T02:23:47-03:00",
                "price": "R$ 12,00"
            }
        ],
        "cliente": {
            "id": null,
            "name": null,
            "external": null
        },
        "externo": {
            "url": "https://faturas.iugu.com/99d3a2a3-6f0e-41bd-a2e1-2965526f81f1-53dc",
            "fatura": "https://faturas.iugu.com/99d3a2a3-6f0e-41bd-a2e1-2965526f81f1-53dc",
            "bankSlipUrl": "https://faturas.iugu.com/99d3a2a3-6f0e-41bd-a2e1-2965526f81f1-53dc"
        },
        "valores": {
            "bruto": 1200,
            "liquido": 1200,
            "original": 1200,
            "juros": null,
            "desconto": null,
            "taxas": null
        },
        "pix": {
            "image": "https://faturas.iugu.com/qr_code/99d3a2a3-6f0e-41bd-a2e1-2965526f81f1-53dc",
            "payload": "00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/99D3A2A36F0E41BDA2E12965526F81F1520400005303986540512.005802BR5925THOMAS FRANKLIN VOLPATO C6011CAMPO LARGO62070503***6304617A",
            "status": "qr_code_created",
            "ete": {
                "id": null,
                "refund_id": null
            }
        },
        "billet": null,
        "status": {
            "text": "canceled"
        },
        "pagamento": {
            "total": null,
            "taxas": null,
            "datas": {
                "sistema": null,
                "cliente": null,
                "capturado": null
            }
        },
        "nossoNumero": "1223",
        "referencia": "1223",
        "split": {
            "id": null,
            "rules": null
        },
        "refunds": {
            "possbile": null,
            "total": 0,
            "brl": "R$ 0,00",
            "data": "1969-12-31 21:00:00"
        }
    }
}