/gateway/integrations/settings

Prod Env

https://api.contadigital.preambulobank.com.br

POST

Requisição

Parâmetros Header

Authorization

string

opcional

Exemplo:

Bearer {Token JWT}

Parâmetros Bodyapplication/json

name

string

requerido

Nome da configuração.

webhookUrl

string

requerido

URL do webhook.

Exemplo

{
    "name": "string",
    "webhookUrl": "string"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.contadigital.preambulobank.com.br/gateway/integrations/settings' \
--header 'Authorization: Bearer {Token JWT}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "webhookUrl": "string"
}'

Respostas

🟢200Success

application/json

Body

retorno

object

requerido

string

requerido

ID da configuração.

name

string

requerido

Nome da configuração.

webhookUrl

string | null

opcional

URL do webhook.

webhookApiKey

string | null

opcional

Chave do webhook.

alertas

array [object {2}]

opcional

mensagem

string | null

opcional

tipo

enum<integer> <int32>

opcional

Valores permitidos:

123456789

erros

array [object {4}]

opcional

mensagem

string | null

opcional

tipo

enum<integer> <int32>

opcional

Valores permitidos:

123456789

campoNome

string | null

opcional

elemento

string | null

opcional

Exemplo

{
    "retorno": {
        "id": "string",
        "name": "string",
        "webhookUrl": "string",
        "webhookApiKey": "string"
    },
    "alertas": [
        {
            "mensagem": "string",
            "tipo": 1
        }
    ],
    "erros": [
        {
            "mensagem": "string",
            "tipo": 1,
            "campoNome": "string",
            "elemento": "string"
        }
    ]
}

Página anterior

/gateway/integrations

Próxima página

/gateway/integrations/secure-key