Configurações da aplicação
Para utilizar a API Open Finance, é recomendado definir o atributo "receberSemChave", da API Pix, como true, pois a configuração incorreta pode afetar as transações. Você pode encontrar o link para o endpoint aqui.
redirectURL
Após o fluxo de autorização do pagamento, o cliente é redirecionado do banco selecionado para a Efí. Em seguida, ele retorna para o site do integrador, com os seguintes parâmetros adicionados à URL:
- identificadorPagamento
- Este parâmetro sempre será adicionado como um
queryParam
na URL do integrador.
Exemplo: https://urldocliente.com.br/callback?identificadorPagamento=urn:bancoabc:1234567677 - erro
- Este parâmetro é adicionado apenas quando ocorre algum erro ou quando o pagamento é recusado pelo cliente.
Exemplo: https://urldocliente.com.br/callback?identificadorPagamento=urn:bancoabc:1234567677&erro=acesso_negado
Configurar URLs da aplicação
Esse endpoint é utilizado para criar ou modificar uma configuração na aplicação relacionada à API Open Finance.
PUT /v1/config
gn.opb.config.write
Requisição
- Configurações das URLs - mTLS
- Configurações das URLs - hmac
// Exemplo configurando uma URL
{
"redirectURL": "https://client.com/redirect/here",
"webhookURL": "https://client.com/callback/here",
"webhookSecurity": {
"type": "mtls"
},
"processPayment": "sync",
"generateTxIdForInic": true
}
// Exemplo configurando uma URL
{
"redirectURL": "https://client.com/redirect/here",
"webhookURL": "https://client.com/callback/here",
"webhookSecurity": {
"type": "hmac",
"hash": "abc123def567ghi"
},
"processPayment": "sync",
"generateTxIdForInic": true
}
Respostas
As respostas abaixo representam Sucesso(201) e Falhas/erros do consumo.
- 🟢 201 (mTLS)
- 🟢 201 (hmac)
- 🔴 400
- 🔴 422
- 🔴 500
{
"redirectURL": "https://client.com/redirect/here",
"webhookURL": "https://client.com/callback/here",
"webhookSecurity": {
"type": "mtls"
},
"processPayment": "sync",
"generateTxIdForInic": true
}
{
"redirectURL": "https://client.com/redirect/here",
"webhookURL": "https://client.com/callback/here",
"webhookSecurity": {
"type": "hmac",
"hash": "abc123def567ghi"
},
"processPayment": "sync",
"generateTxIdForInic": true
}
{
"nome": "redirect_url_obrigatorio",
"mensagem": "O parâmetro redirectURL é obrigatório"
}
Ou
{
"nome": "webhook_url_obrigatorio",
"mensagem": "O parâmetro webhookURL é obrigatório"
}
Ou
{
"nome": "webhook_url_mtls_obrigatorio",
"mensagem": "O webhookURL precisa ter um mTLS válido"
}
{
"nome": "conta_nao_encontrada",
"mensagem": "A conta não foi encontrada"
}
Ou
{
"nome": "redirect_url_invalido",
"mensagem": "O redirectURL é inválido"
}
Ou
{
"nome": "webhook_seguranca_invalido",
"mensagem": "O campo webhookSecurity é inválido"
}
Ou
{
"nome": "webhook_seguranca_hash_invalido",
"mensagem": "O campo hash é inválido"
}
Ou
{
"nome": "webhook_url_invalido",
"mensagem": "webhookURL não acessível"
}
Ou
{
"nome": "webhook_url_invalido",
"mensagem": "Erro ao fazer handshake com mTLS no webhookURL"
}
Ou
{
"nome": "process_payment_invalido",
"mensagem": "O campo processPayment é inválido, permitido (async/sync)"
}
{
"nome": "erro_aplicacao",
"mensagem": "Erro interno do servidor"
}
Retornar as configurações da aplicação
Esse endpoint é utilizado para retornar as configurações da aplicação relacionada a API Open Finance, não é necessário informar nenhum parâmetro.
GET /v1/config
gn.opb.config.read
Respostas
As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.
- 🟢 200
- 🔴 404
- 🔴 500
{
"redirectURL": "https://client.com/redirect/here",
"webhookURL": "https://client.com/callback/here",
"webhookSecurity": {
"type": "mtls"
},
"processPayment": "sync",
"generateTxIdForInic": true
}
{
"nome": "configuracao_nao_encontrada",
"mensagem": "Nenhuma configuração encontrada"
}
{
"nome": "configuracao_nao_encontrada",
"mensagem": "Nenhuma configuração encontrada"
}