Criar Fatura

POST

https://api.tryplopay.com{{base_url}}/invoices

💡

Escopo Necessário: invoice.write

Neste endpoint, você poderá criar uma fatura.

Caso vier informar desconto na fatura, é importante saber que os descontos informados de forma individual em cada produto (payment > products > discount) se soma com o valor informado no campo "payment > discount". Cuide para não implementar descontos indevidos.

Pedimos para considerar o status da situação da cobrança, pelo atributo invoice > status > code, pois ele é padronizado, diferente do "text", que é retornado de acordo com a adquirente. No final da tabela abaixo, encontra a tabela de Status.

STATUS DA FATURA

STATUS (code)	Descrição
1	Aguardando Pagamento
2	Em Processamento
3	Pagamento Agendado
4	Autorizado
5	Pago
6	Cancelado
7	Aguardando Estorno
8	Parcialmente Estornado
9	Estornado
10	Contestado/Em Contestação
12	Pagamento Negado
15	Pagamento Vencido
16	Erro no Pagamento

Abaixo você confere o fluxo dos status.

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/jsonObrigatório

Examples

Respostas

🟢200200 - Sucesso

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.tryplopay.com/invoices' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client": {
        "name": "Suporte TryploPay",
        "document": "00000000000", // obrigatório para nacional
        "email": "suporte@tryplopay.com", // obrigatório para global
        "phone": "4137986803",
        "address": { //obrigatório em caso de ter ao menos 1 produto fisico
            "street": "NOME DA RUA",
            "number": "000",
            "district": "BAIRRO",
            "city": "CENTRO",
            "state": "SC",
            "zipcode": "00000000",
            "country": "BRA"
        },
        "ip": ""
    },
    "ecommerce": { //Uso exclusivo para Checkouts. Informe o ID da loja no Checkout.
        "store_id": 0, //id da loja no checkout
        "checkout": 0 //Código do Checkout Integrado com a gente, solicite ao nosso suporte se necessário.
    },
    "payment": {
        "product_type": 1,
        "id": "TEST_100", // seu id interno
        "type": 3,
        "due_at": "2026-12-27",
        "referrer": "TEST_100", // id de referência, pode ser usado o Interno também.
        "installments": 2,
        "order_url": "https://sualoja.com/pedido/123456",
        "store_url": "https://sualoja.com",
        "webhook": "https://webhook.site/scooby",
        "discount": 0.00,
        "products": [
            {
                "id": "1",
                "image": "https://a.com/image.png",
                "title": "Produto Teste 1",
                "qnt": 10,
                "discount": 0,
                "amount": 1.00
            }
        ],
        "card": { //envio obrigatório em caso de cartão
            "saved": 0, //deixe em 0
            "tokenize": 0, // deixe em 0
            "token": "jZZ2Ccd1ojrfsE7W5KjqDzJvNWR3MHQyTlYxS5Ram53SFQwakE9PQ==", //hash do cartão tokenizado previamente pelo JS
            "valid": "02/33", //vencimento do cartão
            "holder": {
                "name": "FULANO DE TAL" // nome do titular do cartão
            }
        }
    },
    "shipping": {
        "amount": 1.50
    }
}'

Response Example

{
    "date": "2025-08-06 11:41:56",
    "success": true,
    "error": false,
    "type": "invoice",
    "api": {
        "by": "TRYPLOPAY.com",
        "version": "3.0.2",
        "updated": "2025-05-06"
    },
    "__seconds": 0.5462119579315186,
    "invoice": {
        "currency": "BRL",
        "id": "2358230",
        "uuid": "2358230",
        "invoice_id": "7e9de8e865fb5b03a813b3a2b801eb2d",
        "token": "7e9de8e865fb5b03a813b3a2b801eb2d",
        "referrer": "TEST_1754491322879",
        "card": {
            "type": null,
            "tid": null,
            "token": null,
            "bin": null,
            "last4": null,
            "number": null,
            "brand": null,
            "acquirer": null,
            "expire": null,
            "holder": {
                "name": null,
                "document": null
            }
        },
        "created_at": "2025-12-27 00:00:00",
        "due_at": {
            "day": "2025-12-27 00:00:00",
            "original": "2025-12-27 00:00:00"
        },
        "links": {
            "url": null
        },
        "installments": "2",
        "products": [
            {
                "image": "https://a.com/image.png",
                "description": "Produto Teste 1",
                "quantity": 10,
                "discount": "0.00",
                "price_cents": 100
            }
        ],
        "customer": {
            "id": "1346589"
        },
        "subscription": {
            "id": null
        },
        "secure": {
            "id": null,
            "url": null
        },
        "amount": {
            "gross": 10,
            "net": 10,
            "fees": 0,
            "discount": 0,
            "shipping": "0.00"
        },
        "pix": {
            "image": "https://api.tryplopay.com/invoices/qrcode/2358230",
            "payload": "00020101021226880014BR.GOV.BCB.PIX2566qrcodespix.sejaefi.com.br/v2/cobv/21dcdb73751349f29d12b7562289392e5204000053039865802BR5905EFISA6008SAOPAULO62070503***6304F6BA",
            "status": "pending",
            "ete": {
                "id": null,
                "refund_id": null
            }
        },
        "billet": null,
        "payment": {
            "total": 0,
            "fees": 0,
            "dates": {
                "system": null,
                "customer": null,
                "captured": null
            }
        },
        "split": {
            "id": null,
            "rules": null
        },
        "refunds": {
            "possbile": null,
            "total": null,
            "brl": null,
            "data": null
        },
        "webhook": null,
        "status": {
            "text": "pending",
            "sub_text": "pending",
            "code": 1,
            "title": "Aguardando Pagamento",
            "description": "No momento, estamos aguardando o processamento do pagamento. Isso costuma ser rápido, porém, pode levar até 48 horas.",
            "details": null
        }
    }
}

Criar Fatura

STATUS DA FATURA#

Requisição

Respostas

STATUS DA FATURA