Upsert de Cobranças

POST

https://api.sandbox.neofin.services/billing/

Last modified:2025-05-28 15:54:37

Este endpoint permite criar ou atualizar uma cobrança (billing) na plataforma Neofin.

🛠 Comportamento:
Criação:
Se o integration_identifier fornecido não corresponder a nenhuma cobrança existente na Neofin, uma nova cobrança será criada.

Atualização:
Se o integration_identifier corresponder a uma cobrança existente, a cobrança será atualizada com os novos dados enviados.

📌 Observações:
O campo integration_identifier é obrigatório e serve como identificador único para garantir a idempotência da cobrança.

O retorno não incluirá a cobrança criada/atualizada, apenas o status de sucesso ou erro do envio para a fila.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.sandbox.neofin.services/billing/' \
--header 'api-key: ' \
--header 'secret-key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "billings": [
        {
            "address_city": "São Paulo",
            "address_complement": "CJ 4",
            "address_neighborhood": "Jardim Paulista",
            "address_number": "365",
            "address_state": "SP",
            "address_street": "Rua Pamplona",
            "address_zip_code": "01405-000",
            "amount": 150,
            "by_mail": false,
            "by_whatsapp": true,
            "customer_document": "51491769000190",
            "customer_mail": "teste@company.com",
            "customer_name": "Company Teste LTDA",
            "customer_phone": "+5511987654321",
            "customer_secondary_phone": "",
            "discount_before_payment": 0,
            "discount_before_payment_due_date": 0,
            "description": "Parcela 1/2",
            "due_date": 1678316400,
            "fees": 0,
            "fine": 0,
            "installment_type": "custom",
            "installments": 1,
            "nfe_number": "2121212121212",
            "recipients": [],
            "type": "generic",
            "integration_identifier": "1111a",
            "boleto_base64": "",
            "code": "",
            "hash": ""
        }
    ]
}'

Response Example

202 - Example 1

{
    "message": "string",
    "errors": {},
    "metadata": "string"
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢202Billings successfully queued

application/json

Body

🟠400Bad Request - Upsert

🟠403Invalid API Keys

🔴500Erro do servidor

Modified at 2025-05-28 15:54:37

Como realizar o upsert de uma cobrança

Como buscar uma única cobrança