1. Formalization
  • Portal de Integração
    • Introdução
    • Comece por aqui
  • Guia de Integração
    • Autenticação e Credenciais
    • Conceitos fundamentais
    • Fluxo da operação
    • Status da transação
  • Referência da API
    • Contract
      • Buscar contrato e status do fluxo
    • Simulation
      • Iniciar simulação de contrato
      • Re-simulaçãoo de parametros de simulação existente
    • Formalization
      • Iniciar formalizacao do contrato
        POST
    • Reprocessing
      • Reprocessar pagamento
    • Documents
      • Obter URL de arquivo assinado
  1. Formalization

Iniciar formalizacao do contrato

POST
/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.

Requisição

Authorization
API Key
Adicionar parâmetro em header
X-Api-Key
Exemplo:
X-Api-Key: ********************
or
Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200
application/json
Formalizacao aceita.
Body

🟠400
🟠401
🔴500
🔴502
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/partners-api/contracts//contract//formalization' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transaction_id": "string",
    "simulation_id": "string",
    "customer_data": {
        "bank_code": "string",
        "bank_account_type": "CAC",
        "ispb_code": "string",
        "politically_exposed_person": true,
        "city": "string",
        "number": "string",
        "district": "string",
        "street_name": "string",
        "postal_code": "string",
        "state": "string",
        "occupation": "string",
        "birth_date": "2019-08-24",
        "name": "string",
        "document": "string",
        "nationality": "string",
        "gender": "string",
        "email": "string",
        "country_code": "string",
        "pix_key_type": "aleatory_key",
        "pix_key": "string",
        "phone_country_code": "string",
        "phone_area_code": "string",
        "phone_number": "string",
        "bank_branch": "string",
        "bank_account": "string",
        "bank_account_digit": "string"
    }
}'
Response Response Example
200 - Exemplo 1
{
    "success": true,
    "message": "string"
}
Página anterior
Re-simulaçãoo de parametros de simulação existente
Próxima página
Reprocessar pagamento
Built with