/gateway/integrations

Prod Env

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

POST

Requisição

Parâmetros Bodyapplication/json

username

string

requerido

Usuário de acesso a conta.

password

string

requerido

Senha de acesso a conta.

string

requerido

E-mail do responsável

pixKey

string

requerido

Chave pix da conta.

otp

string

requerido

Token seguro.

settingsId

string | null

opcional

ID da configuração.

Exemplo

{
    "username": "string",
    "password": "string",
    "email": "string",
    "pixKey": "string",
    "otp": "string",
    "settingsId": "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' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "string",
    "password": "string",
    "email": "string",
    "pixKey": "string",
    "otp": "string",
    "settingsId": "string"
}'

Respostas

🟢200Success

application/json

Body

retorno

object

requerido

clientId

string

requerido

clientSecret

string

requerido

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": {
        "clientId": "string",
        "clientSecret": "string"
    },
    "alertas": [
        {
            "mensagem": "string",
            "tipo": 1
        }
    ],
    "erros": [
        {
            "mensagem": "string",
            "tipo": 1,
            "campoNome": "string",
            "elemento": "string"
        }
    ]
}

Próxima página

/gateway/integrations/settings