v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Cadastro de Urls

Cadastro de URLs para webhooks de conta

Webhook - Cadastro de URLs de Conta<br/>Este endpoint permite cadastrar URLs para receber webhooks de eventos específicos a nível de conta.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>full_url</td><td>Texto</td><td>URL para onde o webhook será enviado.</td><td>Sim</td></tr><tr><td>is_active_webhook</td><td>Booleano</td><td>Define se o webhook estará ativo ou não.</td><td>Sim</td></tr><tr><td>webhook_type</td><td>Texto</td><td>Tipo do webhook(transaction_reject/transaction).</td><td>Sim</td></tr>s</tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem de sucesso ou erro da operação.</td></tr></tbody></table>

post/api/v1/webhook-account/store

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no header

Request body

full_urlstring
is_active_webhookboolean
webhook_typestring

Example request

{
  "full_url": "https://meusite.com.br/contaaberta",
  "webhook_type": "transaction/transaction_reject"
}

Response

Webhook criado com sucesso.

messagestring

Example response

{
  "message": "Webhook criado com sucesso"
}