Iniciar formalizacao do contrato

POST

https://api.novosaque.dev.br/partners-api/contracts/{product}/contract/{transaction_id}/formalization

Inicia a formalizacao com dados do cliente. Se transaction_id nao for informado no corpo, o valor do path sera usado.

Ao consultar o o contrato em simulation_results teremos as ofertas disponíveis para escolher um simulation_id e utilizar na formalização.

Requisição

Authorization

API Key

Adicionar parâmetro em header

X-Api-Key

Exemplo:

X-Api-Key: ********************

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢202FGTS - formalização com sucesso

application/json

Bodyapplication/json

🟠400FGTS - formalização não disponível para transaction id

🟠401

🔴500

🔴502

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.novosaque.dev.br/partners-api/contracts//contract//formalization' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transaction_id": "b5297798-8421-44cf-a732-643705721701",
    "simulation_id": "49c8aced-e16a-4b6b-bb55-b065ec83fc5a",
    "customer_data": {
        "bank_account": "6622",
        "bank_account_digit": "8",
        "bank_branch": "04861",
        "bank_code": "001",
        "bank_account_type": "CAC",
        "birth_date": "1971-04-16",
        "city": "Barueri",
        "country_code": "BRA",
        "district": "Xingu",
        "email": "email@email.com.br",
        "gender": "M",
        "name": "José da Silva",
        "nationality": "Brasileiro",
        "number": "350",
        "occupation": "AGENTE DE VIAGEM",
        "phone_area_code": "11",
        "phone_country_code": "55",
        "phone_number": "970291614",
        "pix_key": "email@email.com.br",
        "pix_key_type": "email",
        "politically_exposed_person": false,
        "postal_code": "06455030",
        "state": "SP",
        "street_name": "Alameda Xingu"
    }
}'

Response Example

202 - FGTS - formalização com sucesso

{
    "success": true,
    "message": "Internal formalization queued."
}

Página anterior

Buscar contrato e status do fluxo

Próxima página

payment_authorization