Criar configuração de consulta a bureau

POST

/v1/flows/{flowId}/phases/{phaseId}/query-config

Cria a configuração de consulta a bureau (query-config) de uma fase, definindo o título da configuração e a lista de identificadores dos produtos de bureau/AgRisk que serão consultados quando um card entrar na fase.

Se já existir uma configuração de consulta para a fase, um novo envio é tratado como uma atualização: a API retorna erro (409 ou 422) para este método repetido, e a atualização deve ser feita reenviando o mesmo payload via PUT para este mesmo caminho.

Recomendamos consultar a configuração existente (GET) antes de decidir entre criar ou atualizar.

Esta configuração é independente da ação de fase do tipo agrisk, que habilita o disparo efetivo das consultas configuradas aqui. O padrão recomendado é configurar primeiro esta consulta e, só então, criar a ação de fase correspondente.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Configuração criada

application/json

A configuração de consulta a bureau foi criada com sucesso.

Bodyapplication/json

🟠409Configuração já existente

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/flows//phases//query-config' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string",
    "products": [
        "string"
    ]
}'

Response Example

201 - Exemplo 1

{
    "id": "string",
    "title": "string",
    "products": [
        "string"
    ]
}

Modificado em 2026-07-28 20:38:32

Página anterior

Obter configuração de consulta a bureau

Próxima página

Atualizar configuração de consulta a bureau