Inserir proposta

Testing

POST

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

Request

Header Params

Body Params application/json

Example

{
    "id_rate": 1020, 
    "client": {
        "name": "CLIENT NAME", 
        "mother_name": "MOTHER NAME", 
        "birthday": "yyyy-mm-dd", 
        "profession_code": "Outros", 
        "nationality": "brasileira", 
        "maritial_status": "single", 
        "gender": "MASCULINO", 
        "document_type": "rg", 
        "document_number": "123456", 
        "issue_body": "DETRAN", 
        "cpf": "cpf", 
        "email": "email", 
        "phone": "phone" 
    },
    "address": {
        "street": "AV PAULISTA", 
        "state": "SP", 
        "city": "SAO PAULO", 
        "neighborhood": "CENTRO", 
        "number": "", 
        "postal_code": "01310100 " 
    },
    "simulation": {
        "installments": [ 
            {
                "total_amount": 2080.12, 
                "due_date": "2024-10-01" 
            }
        ],
        "issue_amount": 1000.00,
        "annual_rate": 0.23726114, 
        "disbursement_date": "2024-07-01", 
        "issue_date": "2024-07-01" 
    },
    "payment": {
        "pix": {
            "key": "pix11@pix11.com",
            "type": "key",
            "name": "CLIENT NAME",
            "cpf": "cpf"
        }
    }
}

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/insert' \
--header 'x-api-key: PFJTQUtleVZhbHVlPjxNb2R1bHVzPnUzSGZIT0hGb1RVRHh4eWI5bEhHR0JDNjVPc1NOUm0zVmt3VDBGSXdpVzVKenoyRGpVWHFUazFpYnBwQ0ZrL1ZpYUpkcnZHU1dEdHBFblhOakRtaUtscmd0VmF0eTZFbnhUZERSNTQ0THBkQkJGMi9ZMVNoeXJRNTlFNFNmMHZicXA5RU1HVWZpTWx4OWsvVDU5Q3BPakgrenJ6NVlwMGJ5WW9kSHdqWnNXMkhyNDUya2xkemlyc2tNYjJ1RTRldm1Qb213UHV3bmErdHIrdmwweHZITjR6aWU5TFV3dTY2UGF4TTVteUlyUUNrM3dxMExiTUVsWWpVb0hMY2lpT2NqM2I1dlVrQkhBTnVSNW53Ylc1RVpDU0pkWFpFQUNqbEhicVNQS3dyeFpvVjBMZ0RmM1FoS0svWHp2SXEvdDNBMG8wOW9UeHZMUytIdk9rTUZIVFJDUT09PC9Nb2R1bHVzPjxFeHBvbmVudD5BUUFCPC9FeHBvbmVudD48L1JTQUtleVZhbHVlPg==' \
--header 'x-api-token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id_rate": 1020, 
    "client": {
        "name": "CLIENT NAME", 
        "mother_name": "MOTHER NAME", 
        "birthday": "yyyy-mm-dd", 
        "profession_code": "Outros", 
        "nationality": "brasileira", 
        "maritial_status": "single", 
        "gender": "MASCULINO", 
        "document_type": "rg", 
        "document_number": "123456", 
        "issue_body": "DETRAN", 
        "cpf": "cpf", 
        "email": "email", 
        "phone": "phone" 
    },
    "address": {
        "street": "AV PAULISTA", 
        "state": "SP", 
        "city": "SAO PAULO", 
        "neighborhood": "CENTRO", 
        "number": "", 
        "postal_code": "01310100 " 
    },
    "simulation": {
        "installments": [ 
            {
                "total_amount": 2080.12, 
                "due_date": "2024-10-01" 
            }
        ],
        "issue_amount": 1000.00,
        "annual_rate": 0.23726114, 
        "disbursement_date": "2024-07-01", 
        "issue_date": "2024-07-01" 
    },
    "payment": {
        "pix": {
            "key": "pix11@pix11.com",
            "type": "key",
            "name": "CLIENT NAME",
            "cpf": "cpf"
        }
    }
}'

Responses

🟢200OK

application/json

Body

Example

{
    "data": {
        "key": "a86470e0-c0c8-4c46-be60-d473c13f3afd",
        "proposalId": 28407,
        "status": "waiting_signature",
        "additional_iof": 7.677254,
        "annual_cet": "235,9914%",
        "assignment_amount": 2033.65,
        "base_iof": 8.2833555837093,
        "client": {
            "cpf": "66702118805",
            "name": "EDUARDO COELHO BABO"
        },
        "cet": "10,6300%",
        "contract": {
            "number": "0000101551/ECB"
        },
        "disbursed_issue_amount": 1761.93,
        "installments": [
            {
                "total_amount": 2080.12,
                "due_date": "2024-10-01",
                "business_due_date": "2024-10-01"
            }
        ],
        "issue_amount": 2020.33,
        "number_of_installments": 1,
        "total_iof": 15.96,
        "formalization": {
            "key": "6ce19c2c-4bb3-4c09-b1c9-99606962404a",
            "url": "https://crediariohomolog.acesso.io/teggehml/Capture/SMS/Start.aspx?id=6ce19c2c-4bb3-4c09-b1c9-99606962404a"
        }
    }
}

🟠422Unprocessable Entity

🟠401Unauthorized

🔴500Server Error

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

Simulação

Consulta de propostas