Application Settings

Information regarding application settings available in the Open Finance API.

Open Finance API

To use the Open Finance API, it is recommended to set the "receberSemChave" attribute of the Pix API to true, as incorrect configuration can affect transactions. You can find the link to the endpoint here.

Parameters added in redirectURL

After the payment authorization flow, the customer is redirected from the selected bank to Efí. It then returns to the integrator website, with the following parameters added to the URL:

• Payment identifier
• This parameter will always be added as a queryParam in the integrator URL.
  Example: https://urldocliente.com.br/callback?identificadorPagamento=urn:bancoabc:1234567677
• error
• This parameter is only added when an error occurs or when payment is refused by the customer.
  Example: https://urldocliente.com.br/callback?identificadorPagamento=urn:bancoabc:1234567677&erro=acesso_negado

Configure Application URLs

This endpoint is used to create or modify a configuration in the application related to the Open Finance API.

PUT /v1/config

Requires authorization for the scope: gn.opb.config.write

Request

URL settings - mTLS

// Example configuring a URL
{
  "redirectURL": "https://client.com/redirect/here",
  "webhookURL": "https://client.com/callback/here",
  "webhookSecurity": {
    "type": "mtls"
  },
  "processPayment": "sync",
  "generateTxIdForInic": true
}

URL settings - hmac

// Example configuring a URL
{
  "redirectURL": "https://client.com/redirect/here",
  "webhookURL": "https://client.com/callback/here",
  "webhookSecurity": {
    "type": "hmac",
    "hash": "abc123def567ghi"
  },
  "processPayment": "sync",
  "generateTxIdForInic": true
}

Responses

The responses below represent Success(201) and consumption failures/errors.

🟢 201 (mTLS)

{
  "redirectURL": "https://client.com/redirect/here",
  "webhookURL": "https://client.com/callback/here",
  "webhookSecurity": {
    "type": "mtls"
  },
  "processPayment": "sync",
  "generateTxIdForInic": true
}

🟢 201 (hmac)

{
  "redirectURL": "https://client.com/redirect/here",
  "webhookURL": "https://client.com/callback/here",
  "webhookSecurity": {
    "type": "hmac",
    "hash": "abc123def567ghi"
  },
  "processPayment": "sync",
  "generateTxIdForInic": true
}

🔴 400

{
  "nome": "redirect_url_obrigatorio",
  "mensagem": "O parâmetro redirectURL é obrigatório"
}

Or

{
  "nome": "webhook_url_obrigatorio",
  "mensagem": "O parâmetro webhookURL é obrigatório"
}

Or

{
  "nome": "webhook_url_mtls_obrigatorio",
  "mensagem": "O webhookURL precisa ter um mTLS válido"
}

🔴 422

{
  "nome": "conta_nao_encontrada",
  "mensagem": "A conta não foi encontrada"
}

Or

{
  "nome": "redirect_url_invalido",
  "mensagem": "O redirectURL é inválido"
}

Or

{
  "nome": "webhook_seguranca_invalido",
  "mensagem": "O campo webhookSecurity é inválido"
}

Or

{
  "nome": "webhook_seguranca_hash_invalido",
  "mensagem": "O campo hash é inválido"
}

Or

{
  "nome": "webhook_url_invalido",
  "mensagem": "webhookURL não acessível"
}

Or

{
  "nome": "webhook_url_invalido",
  "mensagem": "Erro ao fazer handshake com mTLS no webhookURL"
}

Or

{
  "nome": "process_payment_invalido",
  "mensagem": "O campo processPayment é inválido, permitido (async/sync)"
}

🔴 500

{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}

Get Application Settings

This endpoint is used to retrieve application settings related to the Open Finance API, no parameters need to be provided.

GET /v1/config

Requires authorization for the scope: gn.opb.config.read

Responses

The responses below represent Success(200) and consumption failures/errors.

🟢 200

{
  "redirectURL": "https://client.com/redirect/here",
  "webhookURL": "https://client.com/callback/here",
  "webhookSecurity": {
    "type": "mtls"
  },
  "processPayment": "sync",
  "generateTxIdForInic": true
}

🔴 404

{
  "nome": "configuracao_nao_encontrada",
  "mensagem": "Nenhuma configuração encontrada"
}

🔴 500

{
  "nome": "configuracao_nao_encontrada",
  "mensagem": "Nenhuma configuração encontrada"
}