Pular para o conteúdo principal

Configurações da aplicação

Informações referentes as configurações da aplicação disponíveis na API Open Finance.


API Open Finance

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.


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
Requer autorização para o escopo: gn.opb.config.write


Requisição

// Exemplo configurando uma URL
{
"redirectURL": "https://client.com/redirect/here",
"webhookURL": "https://client.com/callback/here",
"webhookSecurity": {
"type": "mtls"
},
"processPayment": "async"
}

Respostas

As respostas abaixo representam Sucesso(201) e Falhas/erros do consumo.

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

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
Requer autorização para o escopo: gn.opb.config.read


Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

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