Referência da API
SiteCentral de AjudaAPI Status

Incluir uma Conexão

post
https://{apiHost}/v2/admin/connections

Este endpoint é utilizado para cadastrar uma nova conexão.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Informações da conexão a ser cadastrada.

string | null
Defaults to Abc

Nome da Conexão

string
required
Defaults to abc

Slug do provedor financeiro

*Pode ser consultado no endpoint v2/financial/providers.

string
enum
Defaults to production

Ambiente de conexão com o provedor financeiro.

production: Produção.
homologation: Homologação

  • Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.
Allowed:
boolean | null
Defaults to false

Habilita conexão

apis
array of strings

APIs permitidas para o provedor financeiro.

charge/bank_billet: Boleto.
charge/pix: Pix.
payment: Pagamento.
transfer: Transferência

apis
credentials
object
required

Credenciais usadas na autenticação e autorização junto ao provedor.

associations
array of objects

Contas de serviço associadas.

charge.bank_billet_account: Carteira de Boleto.
charge.pix_account: Conta Pix.
payment.account: Conta de Pagamento.
transfer.account: Conta de Transferência.
statement.account: Conta de Extrato

Observação sobre charge.pix_account: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam 422. Em algumas contas a validação ocorre em background; nesse caso a resposta 201 é retornada antes de a validação concluir — acompanhe o resultado via validated_at e enabled_at na PixAccount.

Observação sobre payment.account e transfer.account: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta 201 retorna, e falhas retornam 422 com a mensagem do provedor.

associations
Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?