Criação de Invoices

POST

https://api.novuspagamentos.com/api/v2/invoices

🔁 Idempotência

Envie um UUID v4 único no cabeçalho Idempotency-Key para evitar cobranças duplicadas em caso de retentativa.

Se a mesma chave for enviada novamente, a resposta original é retornada sem criar uma nova cobrança. O cabeçalho é opcional.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Sucesso

application/json

Body

🟠401Auth Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.novuspagamentos.com/api/v2/invoices' \
--header 'Idempotency-Key: 158a5cf8-e871-4ba8-85bd-e7369591681a' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "method": "pix",
    "product_fisical": "digital",
    "total_price_cents": 10,
    "external_id": "1f518767-f53a-489d-bf99-d6776bf7ff63",
    "postback_url": null,
    "payer": {
        "name": "Rebeca Melo",
        "cpf_cnpj": "55036588540",
        "email": "Marli_Silva@bol.com.br",
        "phone": "+55 (89) 9734-1715",
        "address_zip": "35857-762",
        "address_line": "Batista Rua",
        "address_number": "2494",
        "address_complement": "Casa 6",
        "address_city": "Karla do Sul",
        "address_state": "RN",
        "address_neighborhood": "Quadra 56"
    },
    "card": {
        "token": "string",
        "installment": 0,
        "number": "string",
        "first_name": "string",
        "last_name": "string",
        "month": "string",
        "year": "string",
        "security_code": "string",
        "cavv": "string",
        "xid": "string",
        "eci": "string",
        "version": "string",
        "referenceid": "string"
    },
    "items": [
        {
            "name": "Licenciado Phone",
            "description": "Licenciado Phone",
            "quantity": 1,
            "unit_price": 21500
        }
    ],
    "splits": [
        {
            "pix_key": "12345678900",
            "pix_type": "CPF",
            "recipient_name": "João Silva",
            "percentage_basis_points": 2500
        },
        {
            "pix_key": "recipient@email.com",
            "pix_type": "EMAIL",
            "recipient_name": "Maria Santos",
            "amount_cents": 30000
        }
    ]
}'

Response Example

{
    "data": {
        "external_id": "1f518767-f53a-489d-bf99-3232323",
        "invoice_id": "a819a3b0-4373-43bc-bd2c-2323232",
        "order_code": "323232323",
        "qr_code_pix": "00020101021226830014br.gov.bcb.pix2561qrcode.a55scd.com.br/pix/232323",
        "status": "pending",
        "total_cents": 10,
        "installments": 1
    },
    "message": "Fatura criada com sucesso"
}

Criação de Invoices

🔁 Idempotência#

Requisição

Respostas

🔁 Idempotência