Criar cobrança Pix, boleto ou híbrida.

POST

/invoices

Cobranças

Cria uma cobrança Pix, boleto ou híbrida (PIX_BOLETO) para um pagador da conta.

O header x-idempotency-key é obrigatório (1 a 50 caracteres). pixKey é obrigatória quando o método inclui Pix. IMMEDIATE registra na hora; SCHEDULED nasce em rascunho (DRAFT) e precisa ser emitida depois.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

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

Token URL: /oauth/token

Scopes:

invoices.write-Permite criar, alterar ou cancelar cobranças/faturas

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Criado

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠409

🟠422

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location '/invoices' \
--header 'x-account-id;' \
--header 'x-idempotency-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": 0,
    "paymentMethod": "PIX",
    "pixKey": "string",
    "dueDate": "2019-08-24",
    "daysToPay": 0,
    "amount": 1,
    "type": "IMMEDIATE",
    "description": "string",
    "emailTo": "user@example.com",
    "sendEmail": false,
    "interest": {
        "type": 1,
        "amount": 0
    },
    "lateFee": {
        "type": 1,
        "amount": 0
    },
    "discount": {
        "type": 1,
        "value": 1,
        "deadline": "2019-08-24"
    }
}'

Response Example

201 - Exemplo 1

{
    "id": 0,
    "txId": "string",
    "brCode": "string",
    "amount": 0,
    "description": "string",
    "status": "DRAFT",
    "type": "IMMEDIATE",
    "paymentMethod": "PIX",
    "pixKey": "string",
    "boletoBarcode": "string",
    "boletoDigitableLine": "string",
    "dueDate": "2019-08-24T14:15:22.123Z",
    "daysToPay": 0,
    "transactionId": "string",
    "appliedInterest": 0,
    "appliedFee": 0,
    "interest": {
        "type": 1,
        "amount": 0
    },
    "lateFee": {
        "type": 1,
        "amount": 0
    },
    "discount": {
        "type": 1,
        "value": 1,
        "deadline": "2019-08-24"
    },
    "customer": {
        "id": 0,
        "accountId": 0,
        "name": "string",
        "email": "string",
        "phone": "string",
        "document": "string",
        "address": {
            "address": "string",
            "number": "string",
            "complement": "string",
            "district": "string",
            "city": "string",
            "zipCode": "stringst",
            "uf": "st"
        },
        "addresses": [
            {
                "address": "string",
                "number": "string",
                "complement": "string",
                "district": "string",
                "city": "string",
                "zipCode": "stringst",
                "uf": "st"
            }
        ]
    }
}