Simulação

Testing

POST

https://sandbox-api.workbankvirtual.com.br/api/tegge/v1/fgts/simulate

Request

Header Params

Body Params application/json

Example

{
    "search_by_installment": true,
    "value": 0,
    "desired_installments": [
        {
            "total_amount": 3342.50,
            "due_date": "2025-05-01"
        },
        {
            "total_amount": 3074.01,
            "due_date": "2026-05-01"
        },
        {
            "total_amount": 2820.99,
            "due_date": "2027-05-01"
        }
    ],
    "cpf": "66702118805",
    "id_rate": 1019
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox-api.workbankvirtual.com.br/api/tegge/v1/fgts/simulate' \
--header 'x-api-key: PFJTQUtleVZhbHVlPjxNb2R1bHVzPnUzSGZIT0hGb1RVRHh4eWI5bEhHR0JDNjVPc1NOUm0zVmt3VDBGSXdpVzVKenoyRGpVWHFUazFpYnBwQ0ZrL1ZpYUpkcnZHU1dEdHBFblhOakRtaUtscmd0VmF0eTZFbnhUZERSNTQ0THBkQkJGMi9ZMVNoeXJRNTlFNFNmMHZicXA5RU1HVWZpTWx4OWsvVDU5Q3BPakgrenJ6NVlwMGJ5WW9kSHdqWnNXMkhyNDUya2xkemlyc2tNYjJ1RTRldm1Qb213UHV3bmErdHIrdmwweHZITjR6aWU5TFV3dTY2UGF4TTVteUlyUUNrM3dxMExiTUVsWWpVb0hMY2lpT2NqM2I1dlVrQkhBTnVSNW53Ylc1RVpDU0pkWFpFQUNqbEhicVNQS3dyeFpvVjBMZ0RmM1FoS0svWHp2SXEvdDNBMG8wOW9UeHZMUytIdk9rTUZIVFJDUT09PC9Nb2R1bHVzPjxFeHBvbmVudD5BUUFCPC9FeHBvbmVudD48L1JTQUtleVZhbHVlPg==' \
--header 'x-api-token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "search_by_installment": true,
    "value": 0,
    "desired_installments": [
        {
            "total_amount": 3342.50,
            "due_date": "2025-05-01"
        },
        {
            "total_amount": 3074.01,
            "due_date": "2026-05-01"
        },
        {
            "total_amount": 2820.99,
            "due_date": "2027-05-01"
        }
    ],
    "cpf": "66702118805",
    "id_rate": 1019
}'

Responses

🟢200OK

application/json

Body

Example

{
    "installments": [
        {
            "decimal_number": 0,
            "total_amount": 3342.5,
            "tax_amount": 48.45832116065003,
            "due_date": "2025-05-01",
            "business_due_date": "2025-05-02",
            "workdays": 180
        },
        {
            "decimal_number": 0,
            "total_amount": 3074.01,
            "tax_amount": 61.275767225353285,
            "due_date": "2026-05-01",
            "business_due_date": "2026-05-04",
            "workdays": 253
        },
        {
            "decimal_number": 0,
            "total_amount": 2820.99,
            "tax_amount": 68.24123701161119,
            "due_date": "2027-05-01",
            "business_due_date": "2027-05-03",
            "workdays": 250
        }
    ],
    "disbursement_date": "2024-08-12",
    "disbursed_issue_amount": 5589.95,
    "issue_amount": 6582.88,
    "issue_date": "2024-08-12",
    "iof_amount": 202.99,
    "cet": 0.0273,
    "annual_cet": 0.381001,
    "fee_amount": 789.94,
    "disbursement_options": [
        {
            "prefixed_interest_rate": {
                "annual_rate": 0.23726114
            }
        }
    ]
}

🟠401Unauthorized

🔴500Server Error

Modified at 2024-08-15 12:20:52

Consulta de taxas

Inserir proposta